1
1
// @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.
2
8
#[ allow( clippy:: derive_partial_eq_without_eq) ]
3
9
#[ derive( Clone , PartialEq , :: prost:: Message ) ]
4
10
pub struct DataRequest {
@@ -11,6 +17,11 @@ pub struct DataRequest {
11
17
#[ prost( enumeration="Order" , tag="4" ) ]
12
18
pub sort_order : i32 ,
13
19
}
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`.
14
25
#[ allow( clippy:: derive_partial_eq_without_eq) ]
15
26
#[ derive( Clone , PartialEq , :: prost:: Message ) ]
16
27
pub struct Filter {
@@ -38,15 +49,17 @@ pub struct Filter {
38
49
pub interval : :: core:: option:: Option < CaptureInterval > ,
39
50
#[ prost( message, optional, tag="14" ) ]
40
51
pub tags_filter : :: core:: option:: Option < TagsFilter > ,
52
+ /// bbox_labels are used to match documents with the specified bounding box labels (using logical OR)
41
53
#[ prost( string, repeated, tag="15" ) ]
42
54
pub bbox_labels : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
43
55
}
56
+ /// TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.
44
57
#[ allow( clippy:: derive_partial_eq_without_eq) ]
45
58
#[ derive( Clone , PartialEq , :: prost:: Message ) ]
46
59
pub struct TagsFilter {
47
60
#[ prost( enumeration="TagsFilterType" , tag="1" ) ]
48
61
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
50
63
#[ prost( string, repeated, tag="2" ) ]
51
64
pub tags : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
52
65
}
@@ -413,6 +426,7 @@ pub struct BoundingBoxLabelsByFilterResponse {
413
426
#[ prost( string, repeated, tag="1" ) ]
414
427
pub labels : :: prost:: alloc:: vec:: Vec < :: prost:: alloc:: string:: String > ,
415
428
}
429
+ /// Order specifies the order in which data is returned.
416
430
#[ derive( Clone , Copy , Debug , PartialEq , Eq , Hash , PartialOrd , Ord , :: prost:: Enumeration ) ]
417
431
#[ repr( i32 ) ]
418
432
pub enum Order {
0 commit comments