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`
`TABULAR_DATA_SOURCE_TYPE_UNSPECIFIED`
`TABULAR_DATA_SOURCE_TYPE_STANDARD`	TABULAR_DATA_SOURCE_TYPE_STANDARD indicates reading from standard storage. This is
`TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE`	TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE indicates reading from hot storage. This is a
`TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK`	TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK indicates reading the output data of
`Global___TabularDataSourceType`
`INDEXABLE_COLLECTION_UNSPECIFIED`
`INDEXABLE_COLLECTION_HOT_STORE`
`INDEXABLE_COLLECTION_PIPELINE_SINK`
`Global___IndexableCollection`
`INDEX_CREATOR_UNSPECIFIED`
`INDEX_CREATOR_VIAM`
`INDEX_CREATOR_CUSTOMER`
`Global___IndexCreator`
`Global___DataRequest`
`Global___Filter`
`Global___TagsFilter`
`Global___CaptureMetadata`
`Global___CaptureInterval`
`Global___TabularDataByFilterRequest`
`Global___TabularDataByFilterResponse`
`Global___TabularData`
`Global___TabularDataBySQLRequest`
`Global___TabularDataBySQLResponse`
`Global___TabularDataSource`
`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___DeleteTabularFilter`
`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`
`Global___CreateIndexRequest`
`Global___CreateIndexResponse`
`Global___DeleteIndexRequest`
`Global___DeleteIndexResponse`
`Global___ListIndexesRequest`
`Global___ListIndexesResponse`
`Global___Index`
`Global___CreateSavedQueryRequest`
`Global___CreateSavedQueryResponse`
`Global___Query`
`Global___DeleteSavedQueryRequest`
`Global___DeleteSavedQueryResponse`
`Global___GetSavedQueryRequest`
`Global___GetSavedQueryResponse`
`Global___UpdateSavedQueryRequest`
`Global___UpdateSavedQueryResponse`
`Global___ListSavedQueriesRequest`
`Global___ListSavedQueriesResponse`
`Global___CreateBinaryDataSignedURLRequest`
`Global___CreateBinaryDataSignedURLResponse`

Classes

`Order`	Order specifies the order in which data is returned.
`TagsFilterType`	TagsFilterType specifies how data can be filtered based on tags.
`TabularDataSourceType`	TabularDataSourceType specifies the data source type for TabularDataByMQL queries.
`IndexableCollection`	IndexableCollection specifies the types of collections available for custom indexes
`IndexCreator`	IndexCreator specifies the entity that originally created the index
`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.
`TabularDataSource`	TabularDataSource specifies the data source for user queries to execute on.
`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.
`DeleteTabularFilter`	TabularFilter filters tabular data. All fields are optional; omitted fields are treated as unconstrained.
`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.
`CreateIndexRequest`	CreateIndexRequest starts a custom index build
`CreateIndexResponse`	Abstract base class for protocol messages.
`DeleteIndexRequest`	DeleteIndexRequest drops the specified custom index from a collection
`DeleteIndexResponse`	Abstract base class for protocol messages.
`ListIndexesRequest`	ListIndexesRequest returns all the indexes for a given collection
`ListIndexesResponse`	Abstract base class for protocol messages.
`Index`	Abstract base class for protocol messages.
`CreateSavedQueryRequest`	CreateSavedQueryRequest saves a mql query.
`CreateSavedQueryResponse`	Abstract base class for protocol messages.
`Query`	Abstract base class for protocol messages.
`DeleteSavedQueryRequest`	DeleteSavedQuery deletes a saved query based on the given id.
`DeleteSavedQueryResponse`	Abstract base class for protocol messages.
`GetSavedQueryRequest`	GetSavedQuery retrieves a saved query by id.
`GetSavedQueryResponse`	Abstract base class for protocol messages.
`UpdateSavedQueryRequest`	UpdateSavedQuery updates the saved query with the given id.
`UpdateSavedQueryResponse`	Abstract base class for protocol messages.
`ListSavedQueriesRequest`	ListSavedQueries lists saved queries for a given organization.
`ListSavedQueriesResponse`	Abstract base class for protocol messages.
`CreateBinaryDataSignedURLRequest`	Abstract base class for protocol messages.
`CreateBinaryDataSignedURLResponse`	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

type viam.gen.app.data.v1.data_pb2.Global___Order = 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.

type viam.gen.app.data.v1.data_pb2.Global___TagsFilterType = TagsFilterType

class viam.gen.app.data.v1.data_pb2.TabularDataSourceType

Bases: _TabularDataSourceType

TabularDataSourceType specifies the data source type for TabularDataByMQL queries.

viam.gen.app.data.v1.data_pb2.TABULAR_DATA_SOURCE_TYPE_UNSPECIFIED: TabularDataSourceType

viam.gen.app.data.v1.data_pb2.TABULAR_DATA_SOURCE_TYPE_STANDARD: TabularDataSourceType: TABULAR_DATA_SOURCE_TYPE_STANDARD indicates reading from standard storage. This is the default option and available for all data synced to Viam.

viam.gen.app.data.v1.data_pb2.TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE: TabularDataSourceType: TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE indicates reading from hot storage. This is a premium feature requiring opting in specific data sources. See docs at https://docs.viam.com/data-ai/capture-data/advanced/advanced-data-capture-sync/#capture-to-the-hot-data-store

viam.gen.app.data.v1.data_pb2.TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK: TabularDataSourceType: TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK indicates reading the output data of a data pipeline. When using this, a pipeline ID needs to be specified.

type viam.gen.app.data.v1.data_pb2.Global___TabularDataSourceType = TabularDataSourceType

class viam.gen.app.data.v1.data_pb2.IndexableCollection

Bases: _IndexableCollection

IndexableCollection specifies the types of collections available for custom indexes

viam.gen.app.data.v1.data_pb2.INDEXABLE_COLLECTION_UNSPECIFIED: IndexableCollection

viam.gen.app.data.v1.data_pb2.INDEXABLE_COLLECTION_HOT_STORE: IndexableCollection

viam.gen.app.data.v1.data_pb2.INDEXABLE_COLLECTION_PIPELINE_SINK: IndexableCollection

type viam.gen.app.data.v1.data_pb2.Global___IndexableCollection = IndexableCollection

class viam.gen.app.data.v1.data_pb2.IndexCreator

Bases: _IndexCreator

IndexCreator specifies the entity that originally created the index

viam.gen.app.data.v1.data_pb2.INDEX_CREATOR_UNSPECIFIED: IndexCreator

viam.gen.app.data.v1.data_pb2.INDEX_CREATOR_VIAM: IndexCreator

viam.gen.app.data.v1.data_pb2.INDEX_CREATOR_CUSTOMER: IndexCreator

type viam.gen.app.data.v1.data_pb2.Global___IndexCreator = IndexCreator

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

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___DataRequest = 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

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

organization_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

mime_type() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

interval() → Global___CaptureInterval

tags_filter() → Global___TagsFilter

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: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___Filter = 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

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Tags are used to match documents if type is UNSPECIFIED or MATCH_BY_OR.

type viam.gen.app.data.v1.data_pb2.Global___TagsFilter = 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

value() → google.protobuf.any_pb2.Any

HasField(field_name: _HasFieldArgType) → 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

method_parameters() → google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___CaptureMetadata = 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.

start() → google.protobuf.timestamp_pb2.Timestamp

end() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___CaptureInterval = 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

data_request() → Global___DataRequest

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___TabularDataByFilterRequest = 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

metadata() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___CaptureMetadata]

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___TabularData]

type viam.gen.app.data.v1.data_pb2.Global___TabularDataByFilterResponse = 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

data() → google.protobuf.struct_pb2.Struct

time_requested() → google.protobuf.timestamp_pb2.Timestamp

time_received() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___TabularData = 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”.

type viam.gen.app.data.v1.data_pb2.Global___TabularDataBySQLRequest = 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.

raw_data() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

type viam.gen.app.data.v1.data_pb2.Global___TabularDataBySQLResponse = TabularDataBySQLResponse

class viam.gen.app.data.v1.data_pb2.TabularDataSource(*, type: Global___TabularDataSourceType = ..., pipeline_id: str | None = ...)

Bases: google.protobuf.message.Message

TabularDataSource specifies the data source for user queries to execute on.

type: Global___TabularDataSourceType

pipeline_id: str: pipeline_id is the ID of the pipeline to query. Required when using TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK.

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__pipeline_id) → _WhichOneofReturnType__pipeline_id | 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

type viam.gen.app.data.v1.data_pb2.Global___TabularDataSource = TabularDataSource

class viam.gen.app.data.v1.data_pb2.TabularDataByMQLRequest(*, organization_id: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., use_recent_data: bool | None = ..., data_source: Global___TabularDataSource | None = ..., query_prefix_name: str | None = ...)

Bases: google.protobuf.message.Message

TabularDataByMQLRequest requests tabular data using an MQL query.

organization_id: str

use_recent_data: bool: Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.

query_prefix_name: str: query_prefix_name is an optional field that can be used to specify a saved query to run

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.

data_source() → Global___TabularDataSource: data_source is an optional field that can be used to specify the data source for the query. If not specified, the query will run on “standard” storage.

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__data_source) → _WhichOneofReturnType__data_source | None

WhichOneof(oneof_group: _WhichOneofArgType__query_prefix_name) → _WhichOneofReturnType__query_prefix_name | None

WhichOneof(oneof_group: _WhichOneofArgType__use_recent_data) → _WhichOneofReturnType__use_recent_data | 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

type viam.gen.app.data.v1.data_pb2.Global___TabularDataByMQLRequest = 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.

raw_data() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

type viam.gen.app.data.v1.data_pb2.Global___TabularDataByMQLResponse = 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 = ..., additional_parameters: google.protobuf.struct_pb2.Struct | 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

interval() → Global___CaptureInterval

additional_parameters() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__additional_parameters) → _WhichOneofReturnType__additional_parameters | 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

type viam.gen.app.data.v1.data_pb2.Global___ExportTabularDataRequest = ExportTabularDataRequest

class viam.gen.app.data.v1.data_pb2.ExportTabularDataResponse(*, part_id: str = ..., resource_name: str = ..., resource_subtype: 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: google.protobuf.struct_pb2.Struct | 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.

part_id: str

resource_name: str

resource_subtype: str

method_name: str

organization_id: str

location_id: str

robot_name: str

robot_id: str

part_name: str

time_captured() → google.protobuf.timestamp_pb2.Timestamp

method_parameters() → google.protobuf.struct_pb2.Struct

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

payload() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___ExportTabularDataResponse = ExportTabularDataResponse

class viam.gen.app.data.v1.data_pb2.GetLatestTabularDataRequest(*, part_id: str = ..., resource_name: str = ..., method_name: str = ..., resource_subtype: str = ..., additional_parameters: google.protobuf.struct_pb2.Struct | None = ...)

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

additional_parameters() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__additional_parameters) → _WhichOneofReturnType__additional_parameters | 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

type viam.gen.app.data.v1.data_pb2.Global___GetLatestTabularDataRequest = 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.

time_captured() → google.protobuf.timestamp_pb2.Timestamp

time_synced() → google.protobuf.timestamp_pb2.Timestamp

payload() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___GetLatestTabularDataResponse = 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

metadata() → Global___BinaryMetadata

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___BinaryData = 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

data_request() → Global___DataRequest

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___BinaryDataByFilterRequest = 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

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryData]

type viam.gen.app.data.v1.data_pb2.Global___BinaryDataByFilterResponse = 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

type viam.gen.app.data.v1.data_pb2.Global___BinaryID = BinaryID

class viam.gen.app.data.v1.data_pb2.BinaryDataByIDsRequest(*, include_binary: bool = ..., binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

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

include_binary: bool

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___BinaryDataByIDsRequest = 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

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryData]

type viam.gen.app.data.v1.data_pb2.Global___BinaryDataByIDsResponse = 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: _HasFieldArgType) → 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: _WhichOneofArgType__confidence) → _WhichOneofReturnType__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

type viam.gen.app.data.v1.data_pb2.Global___BoundingBox = BoundingBox

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

Bases: google.protobuf.message.Message

Classification represents a confidence score with a label.

id: str

label: str

confidence: float: confidence is an optional range from 0 - 1

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__confidence) → _WhichOneofReturnType__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

type viam.gen.app.data.v1.data_pb2.Global___Classification = 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.

bboxes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BoundingBox]

classifications() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Classification]

type viam.gen.app.data.v1.data_pb2.Global___Annotations = 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 = ..., binary_data_id: str = ...)

Bases: google.protobuf.message.Message

BinaryMetadata is the metadata associated with binary data.

id() → str

file_name: str

file_ext: str

uri: str

binary_data_id: str

capture_metadata() → Global___CaptureMetadata

time_requested() → google.protobuf.timestamp_pb2.Timestamp

time_received() → google.protobuf.timestamp_pb2.Timestamp

annotations() → Global___Annotations

dataset_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___BinaryMetadata = BinaryMetadata

class viam.gen.app.data.v1.data_pb2.DeleteTabularFilter(*, location_ids: collections.abc.Iterable[str] | None = ..., robot_id: str = ..., part_id: str = ..., component_type: str = ..., component_name: str = ..., method: str = ..., tags_filter: Global___TagsFilter | None = ...)

Bases: google.protobuf.message.Message

TabularFilter filters tabular data. All fields are optional; omitted fields are treated as unconstrained.

robot_id: str

part_id: str

component_type: str

component_name: str

method: str

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags_filter() → Global___TagsFilter

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___DeleteTabularFilter = DeleteTabularFilter

class viam.gen.app.data.v1.data_pb2.DeleteTabularDataRequest(*, organization_id: str = ..., delete_older_than_days: int = ..., filter: Global___DeleteTabularFilter | None = ...)

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. If no filter is provided, data will be deleted based on organization_id.

organization_id: str

delete_older_than_days: int

filter() → Global___DeleteTabularFilter

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__filter) → _WhichOneofReturnType__filter | 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

type viam.gen.app.data.v1.data_pb2.Global___DeleteTabularDataRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___DeleteTabularDataResponse = 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

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___DeleteBinaryDataByFilterRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___DeleteBinaryDataByFilterResponse = DeleteBinaryDataByFilterResponse

class viam.gen.app.data.v1.data_pb2.DeleteBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

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

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___DeleteBinaryDataByIDsRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___DeleteBinaryDataByIDsResponse = DeleteBinaryDataByIDsResponse

class viam.gen.app.data.v1.data_pb2.AddTagsToBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | 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.

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___AddTagsToBinaryDataByIDsRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___AddTagsToBinaryDataByIDsResponse = 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.

filter() → Global___Filter

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___AddTagsToBinaryDataByFilterRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___AddTagsToBinaryDataByFilterResponse = AddTagsToBinaryDataByFilterResponse

class viam.gen.app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | 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.

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___RemoveTagsFromBinaryDataByIDsRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___RemoveTagsFromBinaryDataByIDsResponse = 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.

filter() → Global___Filter

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___RemoveTagsFromBinaryDataByFilterRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___RemoveTagsFromBinaryDataByFilterResponse = 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.

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___TagsByFilterRequest = 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.

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___TagsByFilterResponse = TagsByFilterResponse

class viam.gen.app.data.v1.data_pb2.AddBoundingBoxToImageByIDRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_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

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

binary_data_id: str

label: str

x_min_normalized: float

y_min_normalized: float

x_max_normalized: float

y_max_normalized: float

confidence: float

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__confidence) → _WhichOneofReturnType__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

type viam.gen.app.data.v1.data_pb2.Global___AddBoundingBoxToImageByIDRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___AddBoundingBoxToImageByIDResponse = AddBoundingBoxToImageByIDResponse

class viam.gen.app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_id: str = ..., 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.

binary_data_id: str

bbox_id: str

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___RemoveBoundingBoxFromImageByIDRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___RemoveBoundingBoxFromImageByIDResponse = RemoveBoundingBoxFromImageByIDResponse

class viam.gen.app.data.v1.data_pb2.UpdateBoundingBoxRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_id: str = ..., 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 = ..., confidence: 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.

binary_data_id: str

bbox_id: str

label: str

x_min_normalized: float

y_min_normalized: float

x_max_normalized: float

y_max_normalized: float

confidence: float

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__confidence) → _WhichOneofReturnType__confidence | None

WhichOneof(oneof_group: _WhichOneofArgType__label) → _WhichOneofReturnType__label | None

WhichOneof(oneof_group: _WhichOneofArgType__x_max_normalized) → _WhichOneofReturnType__x_max_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__x_min_normalized) → _WhichOneofReturnType__x_min_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__y_max_normalized) → _WhichOneofReturnType__y_max_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__y_min_normalized) → _WhichOneofReturnType__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

type viam.gen.app.data.v1.data_pb2.Global___UpdateBoundingBoxRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___UpdateBoundingBoxResponse = 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.

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___BoundingBoxLabelsByFilterRequest = 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.

labels() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___BoundingBoxLabelsByFilterResponse = 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

type viam.gen.app.data.v1.data_pb2.Global___ConfigureDatabaseUserRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___ConfigureDatabaseUserResponse = 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

type viam.gen.app.data.v1.data_pb2.Global___GetDatabaseConnectionRequest = 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

type viam.gen.app.data.v1.data_pb2.Global___GetDatabaseConnectionResponse = GetDatabaseConnectionResponse

class viam.gen.app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | 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

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___AddBinaryDataToDatasetByIDsRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___AddBinaryDataToDatasetByIDsResponse = AddBinaryDataToDatasetByIDsResponse

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

Bases: google.protobuf.message.Message

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

dataset_id: str

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.data.v1.data_pb2.Global___RemoveBinaryDataFromDatasetByIDsRequest = 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.

type viam.gen.app.data.v1.data_pb2.Global___RemoveBinaryDataFromDatasetByIDsResponse = RemoveBinaryDataFromDatasetByIDsResponse

class viam.gen.app.data.v1.data_pb2.CreateIndexRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_spec: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

CreateIndexRequest starts a custom index build

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

index_spec() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]: index_spec accepts a MongoDB index specification defined in JSON format

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | 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

type viam.gen.app.data.v1.data_pb2.Global___CreateIndexRequest = CreateIndexRequest

class viam.gen.app.data.v1.data_pb2.CreateIndexResponse

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.

type viam.gen.app.data.v1.data_pb2.Global___CreateIndexResponse = CreateIndexResponse

class viam.gen.app.data.v1.data_pb2.DeleteIndexRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_name: str = ...)

Bases: google.protobuf.message.Message

DeleteIndexRequest drops the specified custom index from a collection

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

index_name: str

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | 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

type viam.gen.app.data.v1.data_pb2.Global___DeleteIndexRequest = DeleteIndexRequest

class viam.gen.app.data.v1.data_pb2.DeleteIndexResponse

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.

type viam.gen.app.data.v1.data_pb2.Global___DeleteIndexResponse = DeleteIndexResponse

class viam.gen.app.data.v1.data_pb2.ListIndexesRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ...)

Bases: google.protobuf.message.Message

ListIndexesRequest returns all the indexes for a given collection

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | 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

type viam.gen.app.data.v1.data_pb2.Global___ListIndexesRequest = ListIndexesRequest

class viam.gen.app.data.v1.data_pb2.ListIndexesResponse(*, indexes: collections.abc.Iterable[Global___Index] | 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.

indexes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Index]

type viam.gen.app.data.v1.data_pb2.Global___ListIndexesResponse = ListIndexesResponse

class viam.gen.app.data.v1.data_pb2.Index(*, collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_name: str = ..., index_spec: collections.abc.Iterable[bytes] | None = ..., created_by: Global___IndexCreator = ...)

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.

collection_type: Global___IndexableCollection

pipeline_name: str

index_name: str

created_by: Global___IndexCreator

index_spec() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]: index_spec defines a MongoDB index in JSON format

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | 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

type viam.gen.app.data.v1.data_pb2.Global___Index = Index

class viam.gen.app.data.v1.data_pb2.CreateSavedQueryRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

CreateSavedQueryRequest saves a mql query.

organization_id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

type viam.gen.app.data.v1.data_pb2.Global___CreateSavedQueryRequest = CreateSavedQueryRequest

class viam.gen.app.data.v1.data_pb2.CreateSavedQueryResponse(*, id: str = ...)

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.

id: str

type viam.gen.app.data.v1.data_pb2.Global___CreateSavedQueryResponse = CreateSavedQueryResponse

class viam.gen.app.data.v1.data_pb2.Query(*, id: str = ..., organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | 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.

id: str

organization_id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

created_on() → google.protobuf.timestamp_pb2.Timestamp

updated_at() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___Query = Query

class viam.gen.app.data.v1.data_pb2.DeleteSavedQueryRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

DeleteSavedQuery deletes a saved query based on the given id.

id: str

type viam.gen.app.data.v1.data_pb2.Global___DeleteSavedQueryRequest = DeleteSavedQueryRequest

class viam.gen.app.data.v1.data_pb2.DeleteSavedQueryResponse

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.

type viam.gen.app.data.v1.data_pb2.Global___DeleteSavedQueryResponse = DeleteSavedQueryResponse

class viam.gen.app.data.v1.data_pb2.GetSavedQueryRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

GetSavedQuery retrieves a saved query by id.

id: str

type viam.gen.app.data.v1.data_pb2.Global___GetSavedQueryRequest = GetSavedQueryRequest

class viam.gen.app.data.v1.data_pb2.GetSavedQueryResponse(*, saved_query: Global___Query | 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.

saved_query() → Global___Query

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___GetSavedQueryResponse = GetSavedQueryResponse

class viam.gen.app.data.v1.data_pb2.UpdateSavedQueryRequest(*, id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

UpdateSavedQuery updates the saved query with the given id.

id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

type viam.gen.app.data.v1.data_pb2.Global___UpdateSavedQueryRequest = UpdateSavedQueryRequest

class viam.gen.app.data.v1.data_pb2.UpdateSavedQueryResponse

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.

type viam.gen.app.data.v1.data_pb2.Global___UpdateSavedQueryResponse = UpdateSavedQueryResponse

class viam.gen.app.data.v1.data_pb2.ListSavedQueriesRequest(*, organization_id: str = ..., limit: int = ...)

Bases: google.protobuf.message.Message

ListSavedQueries lists saved queries for a given organization.

organization_id: str

limit: int

type viam.gen.app.data.v1.data_pb2.Global___ListSavedQueriesRequest = ListSavedQueriesRequest

class viam.gen.app.data.v1.data_pb2.ListSavedQueriesResponse(*, queries: collections.abc.Iterable[Global___Query] | 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.

queries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Query]

type viam.gen.app.data.v1.data_pb2.Global___ListSavedQueriesResponse = ListSavedQueriesResponse

class viam.gen.app.data.v1.data_pb2.CreateBinaryDataSignedURLRequest(*, binary_data_id: str = ..., expiration_minutes: int | 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.

binary_data_id: str: The binary data ID of the file to create a signed URL for.

expiration_minutes: int: Expiration time in minutes. Defaults to 15 minutes if not specified. Maximum allowed is 10080 minutes (7 days).

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__expiration_minutes) → _WhichOneofReturnType__expiration_minutes | 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

type viam.gen.app.data.v1.data_pb2.Global___CreateBinaryDataSignedURLRequest = CreateBinaryDataSignedURLRequest

class viam.gen.app.data.v1.data_pb2.CreateBinaryDataSignedURLResponse(*, signed_url: str = ..., expires_at: google.protobuf.timestamp_pb2.Timestamp | 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.

signed_url: str: The signed URL for the binary data file.

expires_at() → google.protobuf.timestamp_pb2.Timestamp: Expiration time of the signed URL token.

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.data.v1.data_pb2.Global___CreateBinaryDataSignedURLResponse = CreateBinaryDataSignedURLResponse