viam.gen.app.data.v1.data_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

DESCRIPTOR

ORDER_UNSPECIFIED

ORDER_DESCENDING

ORDER_ASCENDING

global___Order

TAGS_FILTER_TYPE_UNSPECIFIED

TAGS_FILTER_TYPE_MATCH_BY_OR

TAGS_FILTER_TYPE_MATCH_BY_OR specifies documents matched (using logical OR) on the tags field in the TagsFilter.

TAGS_FILTER_TYPE_TAGGED

TAGS_FILTER_TYPE_TAGGED specifies that all tagged documents should be returned.

TAGS_FILTER_TYPE_UNTAGGED

TAGS_FILTER_TYPE_UNTAGGED specifes that all untagged documents should be returned.

global___TagsFilterType

global___DataRequest

global___Filter

global___TagsFilter

global___CaptureMetadata

global___CaptureInterval

global___TabularDataByFilterRequest

global___TabularDataByFilterResponse

global___TabularData

global___TabularDataBySQLRequest

global___TabularDataBySQLResponse

global___TabularDataByMQLRequest

global___TabularDataByMQLResponse

global___ExportTabularDataRequest

global___ExportTabularDataResponse

global___GetLatestTabularDataRequest

global___GetLatestTabularDataResponse

global___BinaryData

global___BinaryDataByFilterRequest

global___BinaryDataByFilterResponse

global___BinaryID

global___BinaryDataByIDsRequest

global___BinaryDataByIDsResponse

global___BoundingBox

global___Classification

global___Annotations

global___BinaryMetadata

global___DeleteTabularDataRequest

global___DeleteTabularDataResponse

global___DeleteBinaryDataByFilterRequest

global___DeleteBinaryDataByFilterResponse

global___DeleteBinaryDataByIDsRequest

global___DeleteBinaryDataByIDsResponse

global___AddTagsToBinaryDataByIDsRequest

global___AddTagsToBinaryDataByIDsResponse

global___AddTagsToBinaryDataByFilterRequest

global___AddTagsToBinaryDataByFilterResponse

global___RemoveTagsFromBinaryDataByIDsRequest

global___RemoveTagsFromBinaryDataByIDsResponse

global___RemoveTagsFromBinaryDataByFilterRequest

global___RemoveTagsFromBinaryDataByFilterResponse

global___TagsByFilterRequest

global___TagsByFilterResponse

global___AddBoundingBoxToImageByIDRequest

global___AddBoundingBoxToImageByIDResponse

global___RemoveBoundingBoxFromImageByIDRequest

global___RemoveBoundingBoxFromImageByIDResponse

global___UpdateBoundingBoxRequest

global___UpdateBoundingBoxResponse

global___BoundingBoxLabelsByFilterRequest

global___BoundingBoxLabelsByFilterResponse

global___ConfigureDatabaseUserRequest

global___ConfigureDatabaseUserResponse

global___GetDatabaseConnectionRequest

global___GetDatabaseConnectionResponse

global___AddBinaryDataToDatasetByIDsRequest

global___AddBinaryDataToDatasetByIDsResponse

global___RemoveBinaryDataFromDatasetByIDsRequest

global___RemoveBinaryDataFromDatasetByIDsResponse

Classes

Order

Order specifies the order in which data is returned.

TagsFilterType

TagsFilterType specifies how data can be filtered based on tags.

DataRequest

DataRequest encapsulates the filter for the data, a limit on the maximum results returned,

Filter

Filter defines the fields over which we can filter data using a logic AND.

TagsFilter

TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.

CaptureMetadata

CaptureMetadata contains information on the settings used for the data capture.

CaptureInterval

CaptureInterval describes the start and end time of the capture in this file.

TabularDataByFilterRequest

TabularDataByFilterRequest requests tabular data based on filter values.

TabularDataByFilterResponse

TabularDataByFilterResponse provides the data and metadata of tabular data.

TabularData

TabularData contains data and metadata associated with tabular data.

TabularDataBySQLRequest

TabularDataBySQLRequest requests tabular data using a SQL query.

TabularDataBySQLResponse

TabularDataBySQLResponse provides unified tabular data and metadata, queried with SQL.

TabularDataByMQLRequest

TabularDataByMQLRequest requests tabular data using an MQL query.

TabularDataByMQLResponse

TabularDataByMQLResponse provides unified tabular data and metadata, queried with MQL.

ExportTabularDataRequest

ExportTabularDataRequest requests tabular data from the specified data source.

ExportTabularDataResponse

ExportTabularDataResponse provides unified tabular data and metadata for a single data point from the specified data source.

GetLatestTabularDataRequest

GetLatestTabularDataRequest requests the most recent tabular data captured from the specified data source.

GetLatestTabularDataResponse

GetLatestTabularDataResponse provides the data, time synced, and time captured of the most recent tabular data captured

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.

BinaryID

BinaryID is the unique identifier for a file that one can request to be retrieved or modified.

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.

BoundingBox

BoundingBox represents a labeled bounding box on an image.

Classification

Classification represents a confidence score with a label.

Annotations

Annotations are data annotations used for machine learning.

BinaryMetadata

BinaryMetadata is the metadata associated with binary data.

DeleteTabularDataRequest

DeleteTabularDataRequest deletes the data from the organization that is older than delete_older_than_days

DeleteTabularDataResponse

DeleteBinaryDataResponse returns the number of tabular datapoints deleted.

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.

AddTagsToBinaryDataByIDsRequest

AddTagsToBinaryDataByIDsRequest requests adding all specified tags to each of the files when binary ids are provided.

AddTagsToBinaryDataByIDsResponse

Abstract base class for protocol messages.

AddTagsToBinaryDataByFilterRequest

AddTagsToBinaryDataByFilterRequest requests adding all specified tags to each of the files when a filter is provided.

AddTagsToBinaryDataByFilterResponse

Abstract base class for protocol messages.

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

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.

TagsByFilterRequest

TagsByFilterRequest requests the unique tags from data based on given filter.

TagsByFilterResponse

TagsByFilterResponse returns the unique tags from data based on given filter.

AddBoundingBoxToImageByIDRequest

AddBoundingBoxToImageByIDRequest specifies the binary ID to which a bounding box

AddBoundingBoxToImageByIDResponse

AddBoundingBoxToImageByIDResponse returns the bounding box ID of the successfully added bounding box.

RemoveBoundingBoxFromImageByIDRequest

RemoveBoundingBoxFromImageByIDRequest removes the bounding box with specified bounding box ID for the file represented by the binary ID.

RemoveBoundingBoxFromImageByIDResponse

Abstract base class for protocol messages.

UpdateBoundingBoxRequest

UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.

UpdateBoundingBoxResponse

Abstract base class for protocol messages.

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.

ConfigureDatabaseUserRequest

ConfigureDatabaseUserRequest accepts a Viam organization ID and a password for the database user

ConfigureDatabaseUserResponse

Abstract base class for protocol messages.

GetDatabaseConnectionRequest

GetDatabaseConnectionRequest requests the database connection hostname.

GetDatabaseConnectionResponse

GetDatabaseConnectionResponse returns the database connection hostname endpoint. It also returns

AddBinaryDataToDatasetByIDsRequest

AddBinaryDataToDatasetByIDsRequest adds the binary data with the given binary IDs to a dataset with dataset_id.

AddBinaryDataToDatasetByIDsResponse

Abstract base class for protocol messages.

RemoveBinaryDataFromDatasetByIDsRequest

RemoveBinaryDataFromDatasetByIDsRequest removes the specified binary IDs from a dataset with dataset_id.

RemoveBinaryDataFromDatasetByIDsResponse

Abstract base class for protocol messages.

Module Contents

viam.gen.app.data.v1.data_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.app.data.v1.data_pb2.Order

Bases: _Order

Order specifies the order in which data is returned.

viam.gen.app.data.v1.data_pb2.ORDER_UNSPECIFIED: Order
viam.gen.app.data.v1.data_pb2.ORDER_DESCENDING: Order
viam.gen.app.data.v1.data_pb2.ORDER_ASCENDING: Order
viam.gen.app.data.v1.data_pb2.global___Order
class viam.gen.app.data.v1.data_pb2.TagsFilterType

Bases: _TagsFilterType

TagsFilterType specifies how data can be filtered based on tags.

viam.gen.app.data.v1.data_pb2.TAGS_FILTER_TYPE_UNSPECIFIED: TagsFilterType
viam.gen.app.data.v1.data_pb2.TAGS_FILTER_TYPE_MATCH_BY_OR: TagsFilterType

TAGS_FILTER_TYPE_MATCH_BY_OR specifies documents matched (using logical OR) on the tags field in the TagsFilter.

viam.gen.app.data.v1.data_pb2.TAGS_FILTER_TYPE_TAGGED: TagsFilterType

TAGS_FILTER_TYPE_TAGGED specifies that all tagged documents should be returned.

viam.gen.app.data.v1.data_pb2.TAGS_FILTER_TYPE_UNTAGGED: TagsFilterType

TAGS_FILTER_TYPE_UNTAGGED specifes that all untagged documents should be returned.

viam.gen.app.data.v1.data_pb2.global___TagsFilterType
class viam.gen.app.data.v1.data_pb2.DataRequest(*, filter: global___Filter | None = ..., limit: int = ..., last: str = ..., sort_order: global___Order = ...)

Bases: google.protobuf.message.Message

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.

limit: int
last: str
sort_order: global___Order
property filter: global___Filter
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___DataRequest
class viam.gen.app.data.v1.data_pb2.Filter(*, component_name: str = ..., component_type: str = ..., method: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., part_id: str = ..., location_ids: collections.abc.Iterable[str] | None = ..., organization_ids: collections.abc.Iterable[str] | None = ..., mime_type: collections.abc.Iterable[str] | None = ..., interval: global___CaptureInterval | None = ..., tags_filter: global___TagsFilter | None = ..., bbox_labels: collections.abc.Iterable[str] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

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.

component_name: str
component_type: str
method: str
robot_name: str
robot_id: str
part_name: str
part_id: str
dataset_id: str
property location_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property organization_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property mime_type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property interval: global___CaptureInterval
property tags_filter: global___TagsFilter
property bbox_labels: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

bbox_labels are used to match documents with the specified bounding box labels (using logical OR).

HasField(field_name: Literal['interval', b'interval', 'tags_filter', b'tags_filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___Filter
class viam.gen.app.data.v1.data_pb2.TagsFilter(*, type: global___TagsFilterType = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.

type: global___TagsFilterType
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Tags are used to match documents if type is UNSPECIFIED or MATCH_BY_OR.

viam.gen.app.data.v1.data_pb2.global___TagsFilter
class viam.gen.app.data.v1.data_pb2.CaptureMetadata(*, organization_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., part_id: str = ..., component_type: str = ..., component_name: str = ..., method_name: str = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., tags: collections.abc.Iterable[str] | None = ..., mime_type: str = ...)

Bases: google.protobuf.message.Message

CaptureMetadata contains information on the settings used for the data capture.

class MethodParametersEntry(*, key: str = ..., value: google.protobuf.any_pb2.Any | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str
property value: google.protobuf.any_pb2.Any
HasField(field_name: Literal['value', b'value']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

organization_id: str
location_id: str
robot_name: str
robot_id: str
part_name: str
part_id: str
component_type: str
component_name: str
method_name: str
mime_type: str
property method_parameters: google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.app.data.v1.data_pb2.global___CaptureMetadata
class viam.gen.app.data.v1.data_pb2.CaptureInterval(*, start: google.protobuf.timestamp_pb2.Timestamp | None = ..., end: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

CaptureInterval describes the start and end time of the capture in this file.

property start: google.protobuf.timestamp_pb2.Timestamp
property end: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['end', b'end', 'start', b'start']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___CaptureInterval
class viam.gen.app.data.v1.data_pb2.TabularDataByFilterRequest(*, data_request: global___DataRequest | None = ..., count_only: bool = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

TabularDataByFilterRequest requests tabular data based on filter values.

count_only: bool
include_internal_data: bool
property data_request: global___DataRequest
HasField(field_name: Literal['data_request', b'data_request']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___TabularDataByFilterRequest
class viam.gen.app.data.v1.data_pb2.TabularDataByFilterResponse(*, metadata: collections.abc.Iterable[global___CaptureMetadata] | None = ..., data: collections.abc.Iterable[global___TabularData] | None = ..., count: int = ..., last: str = ..., total_size_bytes: int = ...)

Bases: google.protobuf.message.Message

TabularDataByFilterResponse provides the data and metadata of tabular data.

count: int
last: str
total_size_bytes: int
property metadata: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___CaptureMetadata]
property data: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___TabularData]
viam.gen.app.data.v1.data_pb2.global___TabularDataByFilterResponse
class viam.gen.app.data.v1.data_pb2.TabularData(*, data: google.protobuf.struct_pb2.Struct | None = ..., metadata_index: int = ..., time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

TabularData contains data and metadata associated with tabular data.

metadata_index: int
property data: google.protobuf.struct_pb2.Struct
property time_requested: google.protobuf.timestamp_pb2.Timestamp
property time_received: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['data', b'data', 'time_received', b'time_received', 'time_requested', b'time_requested']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___TabularData
class viam.gen.app.data.v1.data_pb2.TabularDataBySQLRequest(*, organization_id: str = ..., sql_query: str = ...)

Bases: google.protobuf.message.Message

TabularDataBySQLRequest requests tabular data using a SQL query.

organization_id: str
sql_query: str

sql_query accepts any valid SQL SELECT statement. Tabular data is held in a database called “sensorData” and a table called readings, so queries should select from “readings” or “sensorData.readings”.

viam.gen.app.data.v1.data_pb2.global___TabularDataBySQLRequest
class viam.gen.app.data.v1.data_pb2.TabularDataBySQLResponse(*, raw_data: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

TabularDataBySQLResponse provides unified tabular data and metadata, queried with SQL.

property raw_data: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]
viam.gen.app.data.v1.data_pb2.global___TabularDataBySQLResponse
class viam.gen.app.data.v1.data_pb2.TabularDataByMQLRequest(*, organization_id: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

TabularDataByMQLRequest requests tabular data using an MQL query.

organization_id: str
property mql_binary: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. The pipeline is run on the “sensorData.readings” namespace, which holds the Viam organization’s tabular data.

viam.gen.app.data.v1.data_pb2.global___TabularDataByMQLRequest
class viam.gen.app.data.v1.data_pb2.TabularDataByMQLResponse(*, raw_data: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

TabularDataByMQLResponse provides unified tabular data and metadata, queried with MQL.

property raw_data: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]
viam.gen.app.data.v1.data_pb2.global___TabularDataByMQLResponse
class viam.gen.app.data.v1.data_pb2.ExportTabularDataRequest(*, part_id: str = ..., resource_name: str = ..., resource_subtype: str = ..., method_name: str = ..., interval: global___CaptureInterval | None = ...)

Bases: google.protobuf.message.Message

ExportTabularDataRequest requests tabular data from the specified data source.

part_id: str
resource_name: str
resource_subtype: str
method_name: str
property interval: global___CaptureInterval
HasField(field_name: Literal['interval', b'interval']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___ExportTabularDataRequest
class viam.gen.app.data.v1.data_pb2.ExportTabularDataResponse(*, part_id: str = ..., component_name: str = ..., component_type: str = ..., method_name: str = ..., time_captured: google.protobuf.timestamp_pb2.Timestamp | None = ..., organization_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., tags: collections.abc.Iterable[str] | None = ..., payload: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

ExportTabularDataResponse provides unified tabular data and metadata for a single data point from the specified data source.

class MethodParametersEntry(*, key: str = ..., value: google.protobuf.any_pb2.Any | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str
property value: google.protobuf.any_pb2.Any
HasField(field_name: Literal['value', b'value']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

part_id: str
component_name: str
component_type: str
method_name: str
organization_id: str
location_id: str
robot_name: str
robot_id: str
part_name: str
property time_captured: google.protobuf.timestamp_pb2.Timestamp
property method_parameters: google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property payload: google.protobuf.struct_pb2.Struct
HasField(field_name: Literal['payload', b'payload', 'time_captured', b'time_captured']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___ExportTabularDataResponse
class viam.gen.app.data.v1.data_pb2.GetLatestTabularDataRequest(*, part_id: str = ..., resource_name: str = ..., method_name: str = ..., resource_subtype: str = ...)

Bases: google.protobuf.message.Message

GetLatestTabularDataRequest requests the most recent tabular data captured from the specified data source.

part_id: str
resource_name: str
method_name: str
resource_subtype: str
viam.gen.app.data.v1.data_pb2.global___GetLatestTabularDataRequest
class viam.gen.app.data.v1.data_pb2.GetLatestTabularDataResponse(*, time_captured: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_synced: google.protobuf.timestamp_pb2.Timestamp | None = ..., payload: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

GetLatestTabularDataResponse provides the data, time synced, and time captured of the most recent tabular data captured from the requested data source, as long as it was synced within the last year.

property time_captured: google.protobuf.timestamp_pb2.Timestamp
property time_synced: google.protobuf.timestamp_pb2.Timestamp
property payload: google.protobuf.struct_pb2.Struct
HasField(field_name: Literal['payload', b'payload', 'time_captured', b'time_captured', 'time_synced', b'time_synced']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___GetLatestTabularDataResponse
class viam.gen.app.data.v1.data_pb2.BinaryData(*, binary: bytes = ..., metadata: global___BinaryMetadata | None = ...)

Bases: google.protobuf.message.Message

BinaryData contains data and metadata associated with binary data.

binary: bytes
property metadata: global___BinaryMetadata
HasField(field_name: Literal['metadata', b'metadata']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___BinaryData
class viam.gen.app.data.v1.data_pb2.BinaryDataByFilterRequest(*, data_request: global___DataRequest | None = ..., include_binary: bool = ..., count_only: bool = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data when a filter is provided.

include_binary: bool
count_only: bool
include_internal_data: bool
property data_request: global___DataRequest
HasField(field_name: Literal['data_request', b'data_request']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___BinaryDataByFilterRequest
class viam.gen.app.data.v1.data_pb2.BinaryDataByFilterResponse(*, data: collections.abc.Iterable[global___BinaryData] | None = ..., count: int = ..., last: str = ..., total_size_bytes: int = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterResponse provides the data and metadata of binary (image + file) data when a filter is provided.

count: int
last: str
total_size_bytes: int
property data: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryData]
viam.gen.app.data.v1.data_pb2.global___BinaryDataByFilterResponse
class viam.gen.app.data.v1.data_pb2.BinaryID(*, file_id: str = ..., organization_id: str = ..., location_id: str = ...)

Bases: google.protobuf.message.Message

BinaryID is the unique identifier for a file that one can request to be retrieved or modified.

file_id: str
organization_id: str
location_id: str
viam.gen.app.data.v1.data_pb2.global___BinaryID
class viam.gen.app.data.v1.data_pb2.BinaryDataByIDsRequest(*, include_binary: bool = ..., binary_ids: collections.abc.Iterable[global___BinaryID] | None = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data by binary ids.

include_binary: bool
property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
viam.gen.app.data.v1.data_pb2.global___BinaryDataByIDsRequest
class viam.gen.app.data.v1.data_pb2.BinaryDataByIDsResponse(*, data: collections.abc.Iterable[global___BinaryData] | None = ..., count: int = ...)

Bases: google.protobuf.message.Message

BinaryDataByIDsResponse provides the data and metadata of binary (image + file) data when a filter is provided.

count: int
property data: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryData]
viam.gen.app.data.v1.data_pb2.global___BinaryDataByIDsResponse
class viam.gen.app.data.v1.data_pb2.BoundingBox(*, id: str = ..., label: str = ..., x_min_normalized: float = ..., y_min_normalized: float = ..., x_max_normalized: float = ..., y_max_normalized: float = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

BoundingBox represents a labeled bounding box on an image. x and y values are normalized ratios between 0 and 1.

id: str
label: str
x_min_normalized: float
y_min_normalized: float
x_max_normalized: float
y_max_normalized: float
confidence: float

confidence is an optional range from 0 - 1

HasField(field_name: Literal['_confidence', b'_confidence', 'confidence', b'confidence']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_confidence', b'_confidence']) Literal['confidence'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

viam.gen.app.data.v1.data_pb2.global___BoundingBox
class viam.gen.app.data.v1.data_pb2.Classification(*, label: str = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

Classification represents a confidence score with a label.

label: str
confidence: float

confidence is an optional range from 0 - 1

HasField(field_name: Literal['_confidence', b'_confidence', 'confidence', b'confidence']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_confidence', b'_confidence']) Literal['confidence'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

viam.gen.app.data.v1.data_pb2.global___Classification
class viam.gen.app.data.v1.data_pb2.Annotations(*, bboxes: collections.abc.Iterable[global___BoundingBox] | None = ..., classifications: collections.abc.Iterable[global___Classification] | None = ...)

Bases: google.protobuf.message.Message

Annotations are data annotations used for machine learning.

property bboxes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BoundingBox]
property classifications: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification]
viam.gen.app.data.v1.data_pb2.global___Annotations
class viam.gen.app.data.v1.data_pb2.BinaryMetadata(*, id: str = ..., capture_metadata: global___CaptureMetadata | None = ..., time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ..., file_name: str = ..., file_ext: str = ..., uri: str = ..., annotations: global___Annotations | None = ..., dataset_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

BinaryMetadata is the metadata associated with binary data.

id: str
file_name: str
file_ext: str
uri: str
property capture_metadata: global___CaptureMetadata
property time_requested: google.protobuf.timestamp_pb2.Timestamp
property time_received: google.protobuf.timestamp_pb2.Timestamp
property annotations: global___Annotations
property dataset_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['annotations', b'annotations', 'capture_metadata', b'capture_metadata', 'time_received', b'time_received', 'time_requested', b'time_requested']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___BinaryMetadata
class viam.gen.app.data.v1.data_pb2.DeleteTabularDataRequest(*, organization_id: str = ..., delete_older_than_days: int = ...)

Bases: google.protobuf.message.Message

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.

organization_id: str
delete_older_than_days: int
viam.gen.app.data.v1.data_pb2.global___DeleteTabularDataRequest
class viam.gen.app.data.v1.data_pb2.DeleteTabularDataResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataResponse returns the number of tabular datapoints deleted.

deleted_count: int
viam.gen.app.data.v1.data_pb2.global___DeleteTabularDataResponse
class viam.gen.app.data.v1.data_pb2.DeleteBinaryDataByFilterRequest(*, filter: global___Filter | None = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByFilterRequest deletes the data and metadata of binary data when a filter is provided.

include_internal_data: bool
property filter: global___Filter
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___DeleteBinaryDataByFilterRequest
class viam.gen.app.data.v1.data_pb2.DeleteBinaryDataByFilterResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByFilterResponse returns the number of binary files deleted when a filter is provided.

deleted_count: int
viam.gen.app.data.v1.data_pb2.global___DeleteBinaryDataByFilterResponse
class viam.gen.app.data.v1.data_pb2.DeleteBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[global___BinaryID] | None = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByIDsRequest deletes the data and metadata of binary data when binary ids are provided.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
viam.gen.app.data.v1.data_pb2.global___DeleteBinaryDataByIDsRequest
class viam.gen.app.data.v1.data_pb2.DeleteBinaryDataByIDsResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByIDsResponse returns the number of binary files deleted when binary ids are provided.

deleted_count: int
viam.gen.app.data.v1.data_pb2.global___DeleteBinaryDataByIDsResponse
class viam.gen.app.data.v1.data_pb2.AddTagsToBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[global___BinaryID] | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

AddTagsToBinaryDataByIDsRequest requests adding all specified tags to each of the files when binary ids are provided.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.app.data.v1.data_pb2.global___AddTagsToBinaryDataByIDsRequest
class viam.gen.app.data.v1.data_pb2.AddTagsToBinaryDataByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___AddTagsToBinaryDataByIDsResponse
class viam.gen.app.data.v1.data_pb2.AddTagsToBinaryDataByFilterRequest(*, filter: global___Filter | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

AddTagsToBinaryDataByFilterRequest requests adding all specified tags to each of the files when a filter is provided.

property filter: global___Filter
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___AddTagsToBinaryDataByFilterRequest
class viam.gen.app.data.v1.data_pb2.AddTagsToBinaryDataByFilterResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___AddTagsToBinaryDataByFilterResponse
class viam.gen.app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[global___BinaryID] | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByIDsRequest requests removing the given tags value from each file when binary ids are provided.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.app.data.v1.data_pb2.global___RemoveTagsFromBinaryDataByIDsRequest
class viam.gen.app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByIDsResponse returns the number of binary files which had tags removed

deleted_count: int
viam.gen.app.data.v1.data_pb2.global___RemoveTagsFromBinaryDataByIDsResponse
class viam.gen.app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterRequest(*, filter: global___Filter | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByFilterRequest requests removing the given tags value from each file when a filter is provided.

property filter: global___Filter
property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___RemoveTagsFromBinaryDataByFilterRequest
class viam.gen.app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByFilterResponse returns the number of binary files which had tags removed.

deleted_count: int
viam.gen.app.data.v1.data_pb2.global___RemoveTagsFromBinaryDataByFilterResponse
class viam.gen.app.data.v1.data_pb2.TagsByFilterRequest(*, filter: global___Filter | None = ...)

Bases: google.protobuf.message.Message

TagsByFilterRequest requests the unique tags from data based on given filter.

property filter: global___Filter
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___TagsByFilterRequest
class viam.gen.app.data.v1.data_pb2.TagsByFilterResponse(*, tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

TagsByFilterResponse returns the unique tags from data based on given filter.

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.app.data.v1.data_pb2.global___TagsByFilterResponse
class viam.gen.app.data.v1.data_pb2.AddBoundingBoxToImageByIDRequest(*, binary_id: global___BinaryID | None = ..., label: str = ..., x_min_normalized: float = ..., y_min_normalized: float = ..., x_max_normalized: float = ..., y_max_normalized: float = ...)

Bases: google.protobuf.message.Message

AddBoundingBoxToImageByIDRequest specifies the binary ID to which a bounding box with the associated label and position in normalized coordinates will be added.

label: str
x_min_normalized: float
y_min_normalized: float
x_max_normalized: float
y_max_normalized: float
property binary_id: global___BinaryID
HasField(field_name: Literal['binary_id', b'binary_id']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___AddBoundingBoxToImageByIDRequest
class viam.gen.app.data.v1.data_pb2.AddBoundingBoxToImageByIDResponse(*, bbox_id: str = ...)

Bases: google.protobuf.message.Message

AddBoundingBoxToImageByIDResponse returns the bounding box ID of the successfully added bounding box.

bbox_id: str
viam.gen.app.data.v1.data_pb2.global___AddBoundingBoxToImageByIDResponse
class viam.gen.app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDRequest(*, binary_id: global___BinaryID | None = ..., bbox_id: str = ...)

Bases: google.protobuf.message.Message

RemoveBoundingBoxFromImageByIDRequest removes the bounding box with specified bounding box ID for the file represented by the binary ID.

bbox_id: str
property binary_id: global___BinaryID
HasField(field_name: Literal['binary_id', b'binary_id']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___RemoveBoundingBoxFromImageByIDRequest
class viam.gen.app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___RemoveBoundingBoxFromImageByIDResponse
class viam.gen.app.data.v1.data_pb2.UpdateBoundingBoxRequest(*, binary_id: global___BinaryID | None = ..., bbox_id: str = ..., label: str | None = ..., x_min_normalized: float | None = ..., y_min_normalized: float | None = ..., x_max_normalized: float | None = ..., y_max_normalized: float | None = ...)

Bases: google.protobuf.message.Message

UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.

bbox_id: str
label: str
x_min_normalized: float
y_min_normalized: float
x_max_normalized: float
y_max_normalized: float
property binary_id: global___BinaryID
HasField(field_name: Literal['_label', b'_label', '_x_max_normalized', b'_x_max_normalized', '_x_min_normalized', b'_x_min_normalized', '_y_max_normalized', b'_y_max_normalized', '_y_min_normalized', b'_y_min_normalized', 'binary_id', b'binary_id', 'label', b'label', 'x_max_normalized', b'x_max_normalized', 'x_min_normalized', b'x_min_normalized', 'y_max_normalized', b'y_max_normalized', 'y_min_normalized', b'y_min_normalized']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_label', b'_label']) Literal['label'] | None
WhichOneof(oneof_group: Literal['_x_max_normalized', b'_x_max_normalized']) Literal['x_max_normalized'] | None
WhichOneof(oneof_group: Literal['_x_min_normalized', b'_x_min_normalized']) Literal['x_min_normalized'] | None
WhichOneof(oneof_group: Literal['_y_max_normalized', b'_y_max_normalized']) Literal['y_max_normalized'] | None
WhichOneof(oneof_group: Literal['_y_min_normalized', b'_y_min_normalized']) Literal['y_min_normalized'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

viam.gen.app.data.v1.data_pb2.global___UpdateBoundingBoxRequest
class viam.gen.app.data.v1.data_pb2.UpdateBoundingBoxResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___UpdateBoundingBoxResponse
class viam.gen.app.data.v1.data_pb2.BoundingBoxLabelsByFilterRequest(*, filter: global___Filter | None = ...)

Bases: google.protobuf.message.Message

BoundingBoxLabelsByFilterRequest requests all the labels of the bounding boxes from files from a given filter.

property filter: global___Filter
HasField(field_name: Literal['filter', b'filter']) bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

viam.gen.app.data.v1.data_pb2.global___BoundingBoxLabelsByFilterRequest
class viam.gen.app.data.v1.data_pb2.BoundingBoxLabelsByFilterResponse(*, labels: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

BoundingBoxLabelsByFilterRequest returns all the labels of the bounding boxes from files from a given filter.

property labels: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.app.data.v1.data_pb2.global___BoundingBoxLabelsByFilterResponse
class viam.gen.app.data.v1.data_pb2.ConfigureDatabaseUserRequest(*, organization_id: str = ..., password: str = ...)

Bases: google.protobuf.message.Message

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.

organization_id: str
password: str
viam.gen.app.data.v1.data_pb2.global___ConfigureDatabaseUserRequest
class viam.gen.app.data.v1.data_pb2.ConfigureDatabaseUserResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___ConfigureDatabaseUserResponse
class viam.gen.app.data.v1.data_pb2.GetDatabaseConnectionRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

GetDatabaseConnectionRequest requests the database connection hostname.

organization_id: str
viam.gen.app.data.v1.data_pb2.global___GetDatabaseConnectionRequest
class viam.gen.app.data.v1.data_pb2.GetDatabaseConnectionResponse(*, hostname: str = ..., mongodb_uri: str = ..., has_database_user: bool = ...)

Bases: google.protobuf.message.Message

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.

hostname: str
mongodb_uri: str
has_database_user: bool
viam.gen.app.data.v1.data_pb2.global___GetDatabaseConnectionResponse
class viam.gen.app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsRequest(*, binary_ids: collections.abc.Iterable[global___BinaryID] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

AddBinaryDataToDatasetByIDsRequest adds the binary data with the given binary IDs to a dataset with dataset_id.

dataset_id: str
property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
viam.gen.app.data.v1.data_pb2.global___AddBinaryDataToDatasetByIDsRequest
class viam.gen.app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___AddBinaryDataToDatasetByIDsResponse
class viam.gen.app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsRequest(*, binary_ids: collections.abc.Iterable[global___BinaryID] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

RemoveBinaryDataFromDatasetByIDsRequest removes the specified binary IDs from a dataset with dataset_id.

dataset_id: str
property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]
viam.gen.app.data.v1.data_pb2.global___RemoveBinaryDataFromDatasetByIDsRequest
class viam.gen.app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.data.v1.data_pb2.global___RemoveBinaryDataFromDatasetByIDsResponse