protos/app/data library Protobuf Definitions

The proto definitions for data

Classes

AddBinaryDataToDatasetByIDsRequest
AddBinaryDataToDatasetByIDsRequest adds the binary data with the given binary IDs to a dataset with dataset_id.
AddBinaryDataToDatasetByIDsResponse
AddBoundingBoxToImageByIDRequest
AddBoundingBoxToImageByIDRequest specifies the binary ID to which a bounding box with the associated label and position in normalized coordinates will be added.
AddBoundingBoxToImageByIDResponse
AddBoundingBoxToImageByIDResponse returns the bounding box ID of the successfully added bounding box.
AddTagsToBinaryDataByFilterRequest
AddTagsToBinaryDataByFilterRequest requests adding all specified tags to each of the files when a filter is provided.
AddTagsToBinaryDataByFilterResponse
AddTagsToBinaryDataByIDsRequest
AddTagsToBinaryDataByIDsRequest requests adding all specified tags to each of the files when binary ids are provided.
AddTagsToBinaryDataByIDsResponse
Annotations
Annotations are data annotations used for machine learning.
BinaryData
BinaryData contains data and metadata associated with binary data.
BinaryDataByFilterRequest
BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data when a filter is provided.
BinaryDataByFilterResponse
BinaryDataByFilterResponse provides the data and metadata of binary (image + file) data when a filter is provided.
BinaryDataByIDsRequest
BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data by binary ids.
BinaryDataByIDsResponse
BinaryDataByIDsResponse provides the data and metadata of binary (image + file) data when a filter is provided.
BinaryID
BinaryID is the unique identifier for a file that one can request to be retrieved or modified.
BinaryMetadata
BinaryMetadata is the metadata associated with binary data.
BoundingBox
BoundingBox represents a labeled bounding box on an image. x and y values are normalized ratios between 0 and 1.
BoundingBoxLabelsByFilterRequest
BoundingBoxLabelsByFilterRequest requests all the labels of the bounding boxes from files from a given filter.
BoundingBoxLabelsByFilterResponse
BoundingBoxLabelsByFilterRequest returns all the labels of the bounding boxes from files from a given filter.
CaptureInterval
CaptureInterval describes the start and end time of the capture in this file.
CaptureMetadata
CaptureMetadata contains information on the settings used for the data capture.
Classification
Classification represents a confidence score with a label.
ConfigureDatabaseUserRequest
ConfigureDatabaseUserRequest accepts a Viam organization ID and a password for the database user being configured. Viam uses gRPC over TLS, so the entire request will be encrypted while in flight, including the password.
ConfigureDatabaseUserResponse
DataRequest
DataRequest encapsulates the filter for the data, a limit on the maximum results returned, a last string associated with the last returned document, and the sorting order by time. last is returned in the responses TabularDataByFilterResponse and BinaryDataByFilterResponse from the API calls TabularDataByFilter and BinaryDataByFilter, respectively. We can then use the last string from the previous API calls in the subsequent request to get the next set of ordered documents.
DataServiceBase
DataServiceClient
DeleteBinaryDataByFilterRequest
DeleteBinaryDataByFilterRequest deletes the data and metadata of binary data when a filter is provided.
DeleteBinaryDataByFilterResponse
DeleteBinaryDataByFilterResponse returns the number of binary files deleted when a filter is provided.
DeleteBinaryDataByIDsRequest
DeleteBinaryDataByIDsRequest deletes the data and metadata of binary data when binary ids are provided.
DeleteBinaryDataByIDsResponse
DeleteBinaryDataByIDsResponse returns the number of binary files deleted when binary ids are provided.
DeleteTabularDataRequest
DeleteTabularDataRequest deletes the data from the organization that is older than delete_older_than_days in UTC time. For example, if delete_older_than_days=1 and the request is made at 1AM EST on March 11 (March 11 5AM UTC), this deletes all data captured through March 10 11:59:59PM UTC. If the request is at 10PM EST on March 11 (March 12 2AM UTC), this deletes all data captured through March 11 11:59:59PM UTC. If delete_older_than_days is 0, all existing data is deleted.
DeleteTabularDataResponse
DeleteBinaryDataResponse returns the number of tabular datapoints deleted.
Filter
Filter defines the fields over which we can filter data using a logic AND. For example, if component_type and robot_id are specified, only data from that robot_id of type component_type is returned. However, we logical OR over the specified tags and bounding box labels, such that if component_type, robot_id, tagA, tagB are specified, we return data from that robot_id of type component_type with tagA or tagB.
GetDatabaseConnectionRequest
GetDatabaseConnectionRequest requests the database connection hostname.
GetDatabaseConnectionResponse
GetDatabaseConnectionResponse returns the database connection hostname endpoint. It also returns a URI that can be used to connect to the database instance through MongoDB clients, as well as information on whether the Viam organization has a database user configured.
Order
Order specifies the order in which data is returned.
RemoveBinaryDataFromDatasetByIDsRequest
RemoveBinaryDataFromDatasetByIDsRequest removes the specified binary IDs from a dataset with dataset_id.
RemoveBinaryDataFromDatasetByIDsResponse
RemoveBoundingBoxFromImageByIDRequest
RemoveBoundingBoxFromImageByIDRequest removes the bounding box with specified bounding box ID for the file represented by the binary ID.
RemoveBoundingBoxFromImageByIDResponse
RemoveTagsFromBinaryDataByFilterRequest
RemoveTagsFromBinaryDataByFilterRequest requests removing the given tags value from each file when a filter is provided.
RemoveTagsFromBinaryDataByFilterResponse
RemoveTagsFromBinaryDataByFilterResponse returns the number of binary files which had tags removed.
RemoveTagsFromBinaryDataByIDsRequest
RemoveTagsFromBinaryDataByIDsRequest requests removing the given tags value from each file when binary ids are provided.
RemoveTagsFromBinaryDataByIDsResponse
RemoveTagsFromBinaryDataByIDsResponse returns the number of binary files which had tags removed
TabularData
TabularData contains data and metadata associated with tabular data.
TabularDataByFilterRequest
TabularDataByFilterRequest requests tabular data based on filter values.
TabularDataByFilterResponse
TabularDataByFilterResponse provides the data and metadata of tabular data.
TabularDataByMQLRequest
TabularDataByMQLRequest requests tabular data using an MQL query.
TabularDataByMQLResponse
TabularDataByMQLResponse provides unified tabular data and metadata, queried with MQL.
TabularDataBySQLRequest
TabularDataBySQLRequest requests tabular data using a SQL query.
TabularDataBySQLResponse
TabularDataBySQLResponse provides unified tabular data and metadata, queried with SQL.
TagsByFilterRequest
TagsByFilterRequest requests the unique tags from data based on given filter.
TagsByFilterResponse
TagsByFilterResponse returns the unique tags from data based on given filter.
TagsFilter
TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.
TagsFilterType
TagsFilterType specifies how data can be filtered based on tags.
UpdateBoundingBoxRequest
UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.
UpdateBoundingBoxResponse

Constants

AddBinaryDataToDatasetByIDsRequest$json → const Map<String, Object>
AddBinaryDataToDatasetByIDsResponse$json → const Map<String, String>
AddBoundingBoxToImageByIDRequest$json → const Map<String, Object>
AddBoundingBoxToImageByIDResponse$json → const Map<String, Object>
AddTagsToBinaryDataByFilterRequest$json → const Map<String, Object>
AddTagsToBinaryDataByFilterResponse$json → const Map<String, String>
AddTagsToBinaryDataByIDsRequest$json → const Map<String, Object>
AddTagsToBinaryDataByIDsResponse$json → const Map<String, String>
Annotations$json → const Map<String, Object>
BinaryData$json → const Map<String, Object>
BinaryDataByFilterRequest$json → const Map<String, Object>
BinaryDataByFilterResponse$json → const Map<String, Object>
BinaryDataByIDsRequest$json → const Map<String, Object>
BinaryDataByIDsResponse$json → const Map<String, Object>
BinaryID$json → const Map<String, Object>
BinaryMetadata$json → const Map<String, Object>
BoundingBox$json → const Map<String, Object>
BoundingBoxLabelsByFilterRequest$json → const Map<String, Object>
BoundingBoxLabelsByFilterResponse$json → const Map<String, Object>
CaptureInterval$json → const Map<String, Object>
CaptureMetadata$json → const Map<String, Object>
CaptureMetadata_MethodParametersEntry$json → const Map<String, Object>
Classification$json → const Map<String, Object>
ConfigureDatabaseUserRequest$json → const Map<String, Object>
ConfigureDatabaseUserResponse$json → const Map<String, String>
DataRequest$json → const Map<String, Object>
DeleteBinaryDataByFilterRequest$json → const Map<String, Object>
DeleteBinaryDataByFilterResponse$json → const Map<String, Object>
DeleteBinaryDataByIDsRequest$json → const Map<String, Object>
DeleteBinaryDataByIDsResponse$json → const Map<String, Object>
DeleteTabularDataRequest$json → const Map<String, Object>
DeleteTabularDataResponse$json → const Map<String, Object>
Filter$json → const Map<String, Object>
GetDatabaseConnectionRequest$json → const Map<String, Object>
GetDatabaseConnectionResponse$json → const Map<String, Object>
Order$json → const Map<String, Object>
RemoveBinaryDataFromDatasetByIDsRequest$json → const Map<String, Object>
RemoveBinaryDataFromDatasetByIDsResponse$json → const Map<String, String>
RemoveBoundingBoxFromImageByIDRequest$json → const Map<String, Object>
RemoveBoundingBoxFromImageByIDResponse$json → const Map<String, String>
RemoveTagsFromBinaryDataByFilterRequest$json → const Map<String, Object>
RemoveTagsFromBinaryDataByFilterResponse$json → const Map<String, Object>
RemoveTagsFromBinaryDataByIDsRequest$json → const Map<String, Object>
RemoveTagsFromBinaryDataByIDsResponse$json → const Map<String, Object>
TabularData$json → const Map<String, Object>
TabularDataByFilterRequest$json → const Map<String, Object>
TabularDataByFilterResponse$json → const Map<String, Object>
TabularDataByMQLRequest$json → const Map<String, Object>
TabularDataByMQLResponse$json → const Map<String, Object>
TabularDataBySQLRequest$json → const Map<String, Object>
TabularDataBySQLResponse$json → const Map<String, Object>
TagsByFilterRequest$json → const Map<String, Object>
TagsByFilterResponse$json → const Map<String, Object>
TagsFilter$json → const Map<String, Object>
TagsFilterType$json → const Map<String, Object>
UpdateBoundingBoxRequest$json → const Map<String, Object>
UpdateBoundingBoxResponse$json → const Map<String, String>

Properties

addBinaryDataToDatasetByIDsRequestDescriptor Uint8List
Descriptor for AddBinaryDataToDatasetByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
addBinaryDataToDatasetByIDsResponseDescriptor Uint8List
Descriptor for AddBinaryDataToDatasetByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
addBoundingBoxToImageByIDRequestDescriptor Uint8List
Descriptor for AddBoundingBoxToImageByIDRequest. Decode as a google.protobuf.DescriptorProto.
final
addBoundingBoxToImageByIDResponseDescriptor Uint8List
Descriptor for AddBoundingBoxToImageByIDResponse. Decode as a google.protobuf.DescriptorProto.
final
addTagsToBinaryDataByFilterRequestDescriptor Uint8List
Descriptor for AddTagsToBinaryDataByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
addTagsToBinaryDataByFilterResponseDescriptor Uint8List
Descriptor for AddTagsToBinaryDataByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
addTagsToBinaryDataByIDsRequestDescriptor Uint8List
Descriptor for AddTagsToBinaryDataByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
addTagsToBinaryDataByIDsResponseDescriptor Uint8List
Descriptor for AddTagsToBinaryDataByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
annotationsDescriptor Uint8List
Descriptor for Annotations. Decode as a google.protobuf.DescriptorProto.
final
binaryDataByFilterRequestDescriptor Uint8List
Descriptor for BinaryDataByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
binaryDataByFilterResponseDescriptor Uint8List
Descriptor for BinaryDataByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
binaryDataByIDsRequestDescriptor Uint8List
Descriptor for BinaryDataByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
binaryDataByIDsResponseDescriptor Uint8List
Descriptor for BinaryDataByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
binaryDataDescriptor Uint8List
Descriptor for BinaryData. Decode as a google.protobuf.DescriptorProto.
final
binaryIDDescriptor Uint8List
Descriptor for BinaryID. Decode as a google.protobuf.DescriptorProto.
final
binaryMetadataDescriptor Uint8List
Descriptor for BinaryMetadata. Decode as a google.protobuf.DescriptorProto.
final
boundingBoxDescriptor Uint8List
Descriptor for BoundingBox. Decode as a google.protobuf.DescriptorProto.
final
boundingBoxLabelsByFilterRequestDescriptor Uint8List
Descriptor for BoundingBoxLabelsByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
boundingBoxLabelsByFilterResponseDescriptor Uint8List
Descriptor for BoundingBoxLabelsByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
captureIntervalDescriptor Uint8List
Descriptor for CaptureInterval. Decode as a google.protobuf.DescriptorProto.
final
captureMetadataDescriptor Uint8List
Descriptor for CaptureMetadata. Decode as a google.protobuf.DescriptorProto.
final
classificationDescriptor Uint8List
Descriptor for Classification. Decode as a google.protobuf.DescriptorProto.
final
configureDatabaseUserRequestDescriptor Uint8List
Descriptor for ConfigureDatabaseUserRequest. Decode as a google.protobuf.DescriptorProto.
final
configureDatabaseUserResponseDescriptor Uint8List
Descriptor for ConfigureDatabaseUserResponse. Decode as a google.protobuf.DescriptorProto.
final
dataRequestDescriptor Uint8List
Descriptor for DataRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteBinaryDataByFilterRequestDescriptor Uint8List
Descriptor for DeleteBinaryDataByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteBinaryDataByFilterResponseDescriptor Uint8List
Descriptor for DeleteBinaryDataByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
deleteBinaryDataByIDsRequestDescriptor Uint8List
Descriptor for DeleteBinaryDataByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteBinaryDataByIDsResponseDescriptor Uint8List
Descriptor for DeleteBinaryDataByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
deleteTabularDataRequestDescriptor Uint8List
Descriptor for DeleteTabularDataRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteTabularDataResponseDescriptor Uint8List
Descriptor for DeleteTabularDataResponse. Decode as a google.protobuf.DescriptorProto.
final
filterDescriptor Uint8List
Descriptor for Filter. Decode as a google.protobuf.DescriptorProto.
final
getDatabaseConnectionRequestDescriptor Uint8List
Descriptor for GetDatabaseConnectionRequest. Decode as a google.protobuf.DescriptorProto.
final
getDatabaseConnectionResponseDescriptor Uint8List
Descriptor for GetDatabaseConnectionResponse. Decode as a google.protobuf.DescriptorProto.
final
orderDescriptor Uint8List
Descriptor for Order. Decode as a google.protobuf.EnumDescriptorProto.
final
removeBinaryDataFromDatasetByIDsRequestDescriptor Uint8List
Descriptor for RemoveBinaryDataFromDatasetByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
removeBinaryDataFromDatasetByIDsResponseDescriptor Uint8List
Descriptor for RemoveBinaryDataFromDatasetByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
removeBoundingBoxFromImageByIDRequestDescriptor Uint8List
Descriptor for RemoveBoundingBoxFromImageByIDRequest. Decode as a google.protobuf.DescriptorProto.
final
removeBoundingBoxFromImageByIDResponseDescriptor Uint8List
Descriptor for RemoveBoundingBoxFromImageByIDResponse. Decode as a google.protobuf.DescriptorProto.
final
removeTagsFromBinaryDataByFilterRequestDescriptor Uint8List
Descriptor for RemoveTagsFromBinaryDataByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
removeTagsFromBinaryDataByFilterResponseDescriptor Uint8List
Descriptor for RemoveTagsFromBinaryDataByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
removeTagsFromBinaryDataByIDsRequestDescriptor Uint8List
Descriptor for RemoveTagsFromBinaryDataByIDsRequest. Decode as a google.protobuf.DescriptorProto.
final
removeTagsFromBinaryDataByIDsResponseDescriptor Uint8List
Descriptor for RemoveTagsFromBinaryDataByIDsResponse. Decode as a google.protobuf.DescriptorProto.
final
tabularDataByFilterRequestDescriptor Uint8List
Descriptor for TabularDataByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
tabularDataByFilterResponseDescriptor Uint8List
Descriptor for TabularDataByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
tabularDataByMQLRequestDescriptor Uint8List
Descriptor for TabularDataByMQLRequest. Decode as a google.protobuf.DescriptorProto.
final
tabularDataByMQLResponseDescriptor Uint8List
Descriptor for TabularDataByMQLResponse. Decode as a google.protobuf.DescriptorProto.
final
tabularDataBySQLRequestDescriptor Uint8List
Descriptor for TabularDataBySQLRequest. Decode as a google.protobuf.DescriptorProto.
final
tabularDataBySQLResponseDescriptor Uint8List
Descriptor for TabularDataBySQLResponse. Decode as a google.protobuf.DescriptorProto.
final
tabularDataDescriptor Uint8List
Descriptor for TabularData. Decode as a google.protobuf.DescriptorProto.
final
tagsByFilterRequestDescriptor Uint8List
Descriptor for TagsByFilterRequest. Decode as a google.protobuf.DescriptorProto.
final
tagsByFilterResponseDescriptor Uint8List
Descriptor for TagsByFilterResponse. Decode as a google.protobuf.DescriptorProto.
final
tagsFilterDescriptor Uint8List
Descriptor for TagsFilter. Decode as a google.protobuf.DescriptorProto.
final
tagsFilterTypeDescriptor Uint8List
Descriptor for TagsFilterType. Decode as a google.protobuf.EnumDescriptorProto.
final
updateBoundingBoxRequestDescriptor Uint8List
Descriptor for UpdateBoundingBoxRequest. Decode as a google.protobuf.DescriptorProto.
final
updateBoundingBoxResponseDescriptor Uint8List
Descriptor for UpdateBoundingBoxResponse. Decode as a google.protobuf.DescriptorProto.
final