11// @generated
2+ /// DataRequest encapsulates the filter for the data, a limit on the maximum results returned,
3+ /// a last string associated with the last returned document, and the sorting order by time.
4+ /// last is returned in the responses TabularDataByFilterResponse and BinaryDataByFilterResponse
5+ /// from the API calls TabularDataByFilter and BinaryDataByFilter, respectively.
6+ /// We can then use the last string from the previous API calls in the subsequent request
7+ /// to get the next set of ordered documents.
28#[ allow( clippy:: derive_partial_eq_without_eq) ]
39#[ derive( Clone , PartialEq , :: prost:: Message ) ]
410pub struct DataRequest {
@@ -11,6 +17,11 @@ pub struct DataRequest {
1117 #[ prost( enumeration="Order" , tag="4" ) ]
1218 pub sort_order : i32 ,
1319}
20+ /// Filter defines the fields over which we can filter data using a logic AND.
21+ /// For example, if component_type and robot_id are specified, only data from that `robot_id` of
22+ /// type `component_type` is returned. However, we logical OR over the specified tags and bounding
23+ /// box labels, such that if component_type, robot_id, tagA, tagB are specified,
24+ /// we return data from that `robot_id` of type `component_type` with `tagA` or `tagB`.
1425#[ allow( clippy:: derive_partial_eq_without_eq) ]
1526#[ derive( Clone , PartialEq , :: prost:: Message ) ]
1627pub struct Filter {
@@ -38,15 +49,17 @@ pub struct Filter {
3849 pub interval : :: core:: option:: Option < CaptureInterval > ,
3950 #[ prost( message, optional, tag="14" ) ]
4051 pub tags_filter : :: core:: option:: Option < TagsFilter > ,
52+ /// bbox_labels are used to match documents with the specified bounding box labels (using logical OR)
4153 #[ prost( string, repeated, tag="15" ) ]
4254 pub bbox_labels : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
4355}
56+ /// TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.
4457#[ allow( clippy:: derive_partial_eq_without_eq) ]
4558#[ derive( Clone , PartialEq , :: prost:: Message ) ]
4659pub struct TagsFilter {
4760 #[ prost( enumeration="TagsFilterType" , tag="1" ) ]
4861 pub r#type : i32 ,
49- /// Tags are used to match documents if `type` is UNSPECIFIED or MATCH_BY_ORG
62+ /// Tags are used to match documents if `type` is UNSPECIFIED or MATCH_BY_OR
5063 #[ prost( string, repeated, tag="2" ) ]
5164 pub tags : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
5265}
@@ -174,10 +187,6 @@ pub struct BinaryDataByIDsRequest {
174187 pub include_binary : bool ,
175188 #[ prost( message, repeated, tag="3" ) ]
176189 pub binary_ids : :: prost:: alloc:: vec:: Vec < BinaryId > ,
177- /// Replaced by binary_ids
178- #[ deprecated]
179- #[ prost( string, repeated, tag="1" ) ]
180- pub file_ids : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
181190}
182191/// BinaryDataByIDsResponse provides the data and metadata of binary (image + file) data when a filter is provided
183192#[ allow( clippy:: derive_partial_eq_without_eq) ]
@@ -267,10 +276,6 @@ pub struct DeleteBinaryDataByFilterResponse {
267276pub struct DeleteBinaryDataByIDsRequest {
268277 #[ prost( message, repeated, tag="2" ) ]
269278 pub binary_ids : :: prost:: alloc:: vec:: Vec < BinaryId > ,
270- /// Replaced by binary_ids
271- #[ deprecated]
272- #[ prost( string, repeated, tag="1" ) ]
273- pub file_ids : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
274279}
275280/// DeleteBinaryDataByIDsResponse returns the number of binary files deleted when binary ids are provided
276281#[ allow( clippy:: derive_partial_eq_without_eq) ]
@@ -287,10 +292,6 @@ pub struct AddTagsToBinaryDataByIDsRequest {
287292 pub binary_ids : :: prost:: alloc:: vec:: Vec < BinaryId > ,
288293 #[ prost( string, repeated, tag="2" ) ]
289294 pub tags : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
290- /// Replaced by binary_ids
291- #[ deprecated]
292- #[ prost( string, repeated, tag="1" ) ]
293- pub file_ids : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
294295}
295296#[ allow( clippy:: derive_partial_eq_without_eq) ]
296297#[ derive( Clone , PartialEq , :: prost:: Message ) ]
@@ -317,10 +318,6 @@ pub struct RemoveTagsFromBinaryDataByIDsRequest {
317318 pub binary_ids : :: prost:: alloc:: vec:: Vec < BinaryId > ,
318319 #[ prost( string, repeated, tag="2" ) ]
319320 pub tags : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
320- /// Replaced by binary_ids
321- #[ deprecated]
322- #[ prost( string, repeated, tag="1" ) ]
323- pub file_ids : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
324321}
325322/// RemoveTagsFromBinaryDataByIDsResponse returns the number of binary files which had tags removed
326323#[ allow( clippy:: derive_partial_eq_without_eq) ]
@@ -374,10 +371,6 @@ pub struct AddBoundingBoxToImageByIdRequest {
374371 pub x_max_normalized : f64 ,
375372 #[ prost( double, tag="6" ) ]
376373 pub y_max_normalized : f64 ,
377- /// Replaced by binary_id
378- #[ deprecated]
379- #[ prost( string, tag="1" ) ]
380- pub file_id : :: prost:: alloc:: string:: String ,
381374}
382375#[ allow( clippy:: derive_partial_eq_without_eq) ]
383376#[ derive( Clone , PartialEq , :: prost:: Message ) ]
@@ -392,10 +385,6 @@ pub struct RemoveBoundingBoxFromImageByIdRequest {
392385 pub binary_id : :: core:: option:: Option < BinaryId > ,
393386 #[ prost( string, tag="2" ) ]
394387 pub bbox_id : :: prost:: alloc:: string:: String ,
395- /// Replaced by binary_id
396- #[ deprecated]
397- #[ prost( string, tag="1" ) ]
398- pub file_id : :: prost:: alloc:: string:: String ,
399388}
400389#[ allow( clippy:: derive_partial_eq_without_eq) ]
401390#[ derive( Clone , PartialEq , :: prost:: Message ) ]
@@ -413,6 +402,7 @@ pub struct BoundingBoxLabelsByFilterResponse {
413402 #[ prost( string, repeated, tag="1" ) ]
414403 pub labels : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
415404}
405+ /// Order specifies the order in which data is returned.
416406#[ derive( Clone , Copy , Debug , PartialEq , Eq , Hash , PartialOrd , Ord , :: prost:: Enumeration ) ]
417407#[ repr( i32 ) ]
418408pub enum Order {
0 commit comments