Skip to content

Commit 447652b

Browse files
authored
[WORKFLOW] Updating protos from viamrobotics/api, commit: daf8c4f89bdd0e988d2469deb1c3c154c863eb05
1 parent fc3c002 commit 447652b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/gen/viam.app.data.v1.rs

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
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)]
410
pub 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)]
1627
pub 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)]
4659
pub 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
}
@@ -413,6 +426,7 @@ pub struct BoundingBoxLabelsByFilterResponse {
413426
#[prost(string, repeated, tag="1")]
414427
pub labels: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
415428
}
429+
/// Order specifies the order in which data is returned.
416430
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
417431
#[repr(i32)]
418432
pub enum Order {

0 commit comments

Comments
 (0)