protos: added metadata to remote-files (#351)

Author: bgfreeman7

go/gen/sift/remote_files/v1/remote_files.pb.go

@@ -7,6 +7,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
+import "sift/metadata/v1/metadata.proto";
 
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {title: "RemoteFile service"}
@@ -106,6 +107,7 @@ message RemoteFile {
   string modified_by_user_id = 14 [(google.api.field_behavior) = REQUIRED];
   google.protobuf.Timestamp created_date = 15 [(google.api.field_behavior) = REQUIRED];
   google.protobuf.Timestamp modified_date = 16 [(google.api.field_behavior) = REQUIRED];
+  repeated sift.metadata.v1.MetadataValue metadata_values = 18 [(google.api.field_behavior) = OPTIONAL];
 }
 
 message VideoMetadata {
@@ -158,7 +160,7 @@ message ListRemoteFilesRequest {
   string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
-  // Available fields to filter by are `remote_file_id`, `entity_id`, `entity_type`, and `file_name`.
+  // Available fields to filter by are `remote_file_id`, `entity_id`, `entity_type`, `metadata`, and `file_name`.
   // For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
   // For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/remote_files#remotefile). Optional.
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
@@ -193,6 +195,9 @@ message CreateRemoteFileRequest {
 
   // A custom UUID used to generate the object key. Recommended to be left unset.
   optional string custom_uuid = 11 [(google.api.field_behavior) = OPTIONAL];
+
+  // The metadata values associated with this remote file.
+  repeated sift.metadata.v1.MetadataValue metadata_values = 13 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for a call to `RemoteFileService_CreateRemoteFile`.
@@ -222,7 +227,7 @@ message UpdateRemoteFileRequest {
   // The remote file to update.
   RemoteFile remote_file = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // The list of fields to be updated. The fields available to be updated are `description` and `metadata`.
+  // The list of fields to be updated. The fields available to be updated are `description`, `metadata_values`, and `metadata`.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 

go/gen/sift/remote_files/v1/remote_files_vtproto.pb.go

@@ -11,6 +11,7 @@ import google.protobuf.internal.containers
 import google.protobuf.internal.enum_type_wrapper
 import google.protobuf.message
 import google.protobuf.timestamp_pb2
+import sift.metadata.v1.metadata_pb2
 import sys
 import typing
 
@@ -65,6 +66,7 @@ class RemoteFile(google.protobuf.message.Message):
     MODIFIED_BY_USER_ID_FIELD_NUMBER: builtins.int
     CREATED_DATE_FIELD_NUMBER: builtins.int
     MODIFIED_DATE_FIELD_NUMBER: builtins.int
+    METADATA_VALUES_FIELD_NUMBER: builtins.int
     remote_file_id: builtins.str
     organization_id: builtins.str
     entity_id: builtins.str
@@ -87,6 +89,8 @@ class RemoteFile(google.protobuf.message.Message):
     def created_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
     @property
     def modified_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    @property
+    def metadata_values(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[sift.metadata.v1.metadata_pb2.MetadataValue]: ...
     def __init__(
         self,
         *,
@@ -107,9 +111,10 @@ class RemoteFile(google.protobuf.message.Message):
         modified_by_user_id: builtins.str = ...,
         created_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
         modified_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+        metadata_values: collections.abc.Iterable[sift.metadata.v1.metadata_pb2.MetadataValue] | None = ...,
     ) -> None: ...
     def HasField(self, field_name: typing.Literal["_description", b"_description", "audio_metadata", b"audio_metadata", "created_date", b"created_date", "description", b"description", "image_metadata", b"image_metadata", "metadata", b"metadata", "modified_date", b"modified_date", "video_metadata", b"video_metadata"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["_description", b"_description", "audio_metadata", b"audio_metadata", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "organization_id", b"organization_id", "remote_file_id", b"remote_file_id", "storage_key", b"storage_key", "video_metadata", b"video_metadata"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["_description", b"_description", "audio_metadata", b"audio_metadata", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "metadata_values", b"metadata_values", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "organization_id", b"organization_id", "remote_file_id", b"remote_file_id", "storage_key", b"storage_key", "video_metadata", b"video_metadata"]) -> None: ...
     @typing.overload
     def WhichOneof(self, oneof_group: typing.Literal["_description", b"_description"]) -> typing.Literal["description"] | None: ...
     @typing.overload
@@ -240,7 +245,7 @@ class ListRemoteFilesRequest(google.protobuf.message.Message):
     """
     filter: builtins.str
     """A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
-    Available fields to filter by are `remote_file_id`, `entity_id`, `entity_type`, and `file_name`.
+    Available fields to filter by are `remote_file_id`, `entity_id`, `entity_type`, `metadata`, and `file_name`.
     For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
     For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/remote_files#remotefile). Optional.
     """
@@ -297,6 +302,7 @@ class CreateRemoteFileRequest(google.protobuf.message.Message):
     IMAGE_METADATA_FIELD_NUMBER: builtins.int
     AUDIO_METADATA_FIELD_NUMBER: builtins.int
     CUSTOM_UUID_FIELD_NUMBER: builtins.int
+    METADATA_VALUES_FIELD_NUMBER: builtins.int
     file_name: builtins.str
     entity_id: builtins.str
     entity_type: global___EntityType.ValueType
@@ -314,6 +320,10 @@ class CreateRemoteFileRequest(google.protobuf.message.Message):
     def image_metadata(self) -> global___ImageMetadata: ...
     @property
     def audio_metadata(self) -> global___AudioMetadata: ...
+    @property
+    def metadata_values(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[sift.metadata.v1.metadata_pb2.MetadataValue]:
+        """The metadata values associated with this remote file."""
+
     def __init__(
         self,
         *,
@@ -329,9 +339,10 @@ class CreateRemoteFileRequest(google.protobuf.message.Message):
         image_metadata: global___ImageMetadata | None = ...,
         audio_metadata: global___AudioMetadata | None = ...,
         custom_uuid: builtins.str | None = ...,
+        metadata_values: collections.abc.Iterable[sift.metadata.v1.metadata_pb2.MetadataValue] | None = ...,
     ) -> None: ...
     def HasField(self, field_name: typing.Literal["_custom_uuid", b"_custom_uuid", "_description", b"_description", "audio_metadata", b"audio_metadata", "custom_uuid", b"custom_uuid", "description", b"description", "image_metadata", b"image_metadata", "metadata", b"metadata", "video_metadata", b"video_metadata"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["_custom_uuid", b"_custom_uuid", "_description", b"_description", "audio_metadata", b"audio_metadata", "custom_uuid", b"custom_uuid", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "organization_id", b"organization_id", "video_metadata", b"video_metadata"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["_custom_uuid", b"_custom_uuid", "_description", b"_description", "audio_metadata", b"audio_metadata", "custom_uuid", b"custom_uuid", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "metadata_values", b"metadata_values", "organization_id", b"organization_id", "video_metadata", b"video_metadata"]) -> None: ...
     @typing.overload
     def WhichOneof(self, oneof_group: typing.Literal["_custom_uuid", b"_custom_uuid"]) -> typing.Literal["custom_uuid"] | None: ...
     @typing.overload
@@ -435,7 +446,7 @@ class UpdateRemoteFileRequest(google.protobuf.message.Message):
 
     @property
     def update_mask(self) -> google.protobuf.field_mask_pb2.FieldMask:
-        """The list of fields to be updated. The fields available to be updated are `description` and `metadata`."""
+        """The list of fields to be updated. The fields available to be updated are `description`, `metadata_values`, and `metadata`."""
 
     def __init__(
         self,

protos/sift/remote_files/v1/remote_files.proto

@@ -31,6 +31,8 @@ pub struct RemoteFile {
     pub created_date: ::core::option::Option<::pbjson_types::Timestamp>,
     #[prost(message, optional, tag="16")]
     pub modified_date: ::core::option::Option<::pbjson_types::Timestamp>,
+    #[prost(message, repeated, tag="18")]
+    pub metadata_values: ::prost::alloc::vec::Vec<super::super::metadata::v1::MetadataValue>,
     #[prost(oneof="remote_file::Metadata", tags="11, 12, 17")]
     pub metadata: ::core::option::Option<remote_file::Metadata>,
 }
@@ -128,6 +130,8 @@ pub struct CreateRemoteFileRequest {
     pub organization_id: ::prost::alloc::string::String,
     #[prost(string, optional, tag="11")]
     pub custom_uuid: ::core::option::Option<::prost::alloc::string::String>,
+    #[prost(message, repeated, tag="13")]
+    pub metadata_values: ::prost::alloc::vec::Vec<super::super::metadata::v1::MetadataValue>,
     #[prost(oneof="create_remote_file_request::Metadata", tags="9, 10, 12")]
     pub metadata: ::core::option::Option<create_remote_file_request::Metadata>,
 }

python/lib/sift/remote_files/v1/remote_files_pb2.py

@@ -308,6 +308,9 @@ impl serde::Serialize for CreateRemoteFileRequest {
         if self.custom_uuid.is_some() {
             len += 1;
         }
+        if !self.metadata_values.is_empty() {
+            len += 1;
+        }
         if self.metadata.is_some() {
             len += 1;
         }
@@ -342,6 +345,9 @@ impl serde::Serialize for CreateRemoteFileRequest {
         if let Some(v) = self.custom_uuid.as_ref() {
             struct_ser.serialize_field("customUuid", v)?;
         }
+        if !self.metadata_values.is_empty() {
+            struct_ser.serialize_field("metadataValues", &self.metadata_values)?;
+        }
         if let Some(v) = self.metadata.as_ref() {
             match v {
                 create_remote_file_request::Metadata::VideoMetadata(v) => {
@@ -382,6 +388,8 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
             "organizationId",
             "custom_uuid",
             "customUuid",
+            "metadata_values",
+            "metadataValues",
             "video_metadata",
             "videoMetadata",
             "image_metadata",
@@ -401,6 +409,7 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
             Description,
             OrganizationId,
             CustomUuid,
+            MetadataValues,
             VideoMetadata,
             ImageMetadata,
             AudioMetadata,
@@ -434,6 +443,7 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
                             "description" => Ok(GeneratedField::Description),
                             "organizationId" | "organization_id" => Ok(GeneratedField::OrganizationId),
                             "customUuid" | "custom_uuid" => Ok(GeneratedField::CustomUuid),
+                            "metadataValues" | "metadata_values" => Ok(GeneratedField::MetadataValues),
                             "videoMetadata" | "video_metadata" => Ok(GeneratedField::VideoMetadata),
                             "imageMetadata" | "image_metadata" => Ok(GeneratedField::ImageMetadata),
                             "audioMetadata" | "audio_metadata" => Ok(GeneratedField::AudioMetadata),
@@ -465,6 +475,7 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
                 let mut description__ = None;
                 let mut organization_id__ = None;
                 let mut custom_uuid__ = None;
+                let mut metadata_values__ = None;
                 let mut metadata__ = None;
                 while let Some(k) = map_.next_key()? {
                     match k {
@@ -524,6 +535,12 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
                             }
                             custom_uuid__ = map_.next_value()?;
                         }
+                        GeneratedField::MetadataValues => {
+                            if metadata_values__.is_some() {
+                                return Err(serde::de::Error::duplicate_field("metadataValues"));
+                            }
+                            metadata_values__ = Some(map_.next_value()?);
+                        }
                         GeneratedField::VideoMetadata => {
                             if metadata__.is_some() {
                                 return Err(serde::de::Error::duplicate_field("videoMetadata"));
@@ -557,6 +574,7 @@ impl<'de> serde::Deserialize<'de> for CreateRemoteFileRequest {
                     description: description__,
                     organization_id: organization_id__.unwrap_or_default(),
                     custom_uuid: custom_uuid__,
+                    metadata_values: metadata_values__.unwrap_or_default(),
                     metadata: metadata__,
                 })
             }
@@ -1689,6 +1707,9 @@ impl serde::Serialize for RemoteFile {
         if self.modified_date.is_some() {
             len += 1;
         }
+        if !self.metadata_values.is_empty() {
+            len += 1;
+        }
         if self.metadata.is_some() {
             len += 1;
         }
@@ -1738,6 +1759,9 @@ impl serde::Serialize for RemoteFile {
         if let Some(v) = self.modified_date.as_ref() {
             struct_ser.serialize_field("modifiedDate", v)?;
         }
+        if !self.metadata_values.is_empty() {
+            struct_ser.serialize_field("metadataValues", &self.metadata_values)?;
+        }
         if let Some(v) = self.metadata.as_ref() {
             match v {
                 remote_file::Metadata::VideoMetadata(v) => {
@@ -1788,6 +1812,8 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
             "createdDate",
             "modified_date",
             "modifiedDate",
+            "metadata_values",
+            "metadataValues",
             "video_metadata",
             "videoMetadata",
             "image_metadata",
@@ -1812,6 +1838,7 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
             ModifiedByUserId,
             CreatedDate,
             ModifiedDate,
+            MetadataValues,
             VideoMetadata,
             ImageMetadata,
             AudioMetadata,
@@ -1850,6 +1877,7 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
                             "modifiedByUserId" | "modified_by_user_id" => Ok(GeneratedField::ModifiedByUserId),
                             "createdDate" | "created_date" => Ok(GeneratedField::CreatedDate),
                             "modifiedDate" | "modified_date" => Ok(GeneratedField::ModifiedDate),
+                            "metadataValues" | "metadata_values" => Ok(GeneratedField::MetadataValues),
                             "videoMetadata" | "video_metadata" => Ok(GeneratedField::VideoMetadata),
                             "imageMetadata" | "image_metadata" => Ok(GeneratedField::ImageMetadata),
                             "audioMetadata" | "audio_metadata" => Ok(GeneratedField::AudioMetadata),
@@ -1886,6 +1914,7 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
                 let mut modified_by_user_id__ = None;
                 let mut created_date__ = None;
                 let mut modified_date__ = None;
+                let mut metadata_values__ = None;
                 let mut metadata__ = None;
                 while let Some(k) = map_.next_key()? {
                     match k {
@@ -1975,6 +2004,12 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
                             }
                             modified_date__ = map_.next_value()?;
                         }
+                        GeneratedField::MetadataValues => {
+                            if metadata_values__.is_some() {
+                                return Err(serde::de::Error::duplicate_field("metadataValues"));
+                            }
+                            metadata_values__ = Some(map_.next_value()?);
+                        }
                         GeneratedField::VideoMetadata => {
                             if metadata__.is_some() {
                                 return Err(serde::de::Error::duplicate_field("videoMetadata"));
@@ -2013,6 +2048,7 @@ impl<'de> serde::Deserialize<'de> for RemoteFile {
                     modified_by_user_id: modified_by_user_id__.unwrap_or_default(),
                     created_date: created_date__,
                     modified_date: modified_date__,
+                    metadata_values: metadata_values__.unwrap_or_default(),
                     metadata: metadata__,
                 })
             }

python/lib/sift/remote_files/v1/remote_files_pb2.pyi

@@ -85,8 +85,6 @@ pub mod test_report_service_client {
             self.inner = self.inner.max_encoding_message_size(limit);
             self
         }
-        /** Imports a test report from an already-uploaded file
-*/
         pub async fn import_test_report(
             &mut self,
             request: impl tonic::IntoRequest<super::ImportTestReportRequest>,
@@ -437,8 +435,6 @@ pub mod test_report_service_client {
                 );
             self.inner.unary(req, path, codec).await
         }
-        /** Creates multiple test measurements in a single request
-*/
         pub async fn create_test_measurements(
             &mut self,
             request: impl tonic::IntoRequest<super::CreateTestMeasurementsRequest>,
@@ -628,8 +624,6 @@ pub mod test_report_service_server {
     /// Generated trait containing gRPC methods that should be implemented for use with TestReportServiceServer.
     #[async_trait]
     pub trait TestReportService: Send + Sync + 'static {
-        /** Imports a test report from an already-uploaded file
-*/
         async fn import_test_report(
             &self,
             request: tonic::Request<super::ImportTestReportRequest>,
@@ -727,8 +721,6 @@ pub mod test_report_service_server {
             tonic::Response<super::CreateTestMeasurementResponse>,
             tonic::Status,
         >;
-        /** Creates multiple test measurements in a single request
-*/
         async fn create_test_measurements(
             &self,
             request: tonic::Request<super::CreateTestMeasurementsRequest>,