viam.gen.app.datasync.v1.data_sync_pb2

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

Classes

`MimeType`
`DataType`	DataType specifies the type of data uploaded.
`DataCaptureUploadRequest`	DataCaptureUploadRequest requests to upload the contents and metadata for tabular data.
`DataCaptureUploadResponse`	DataCaptureUploadResponse returns the file id of the uploaded contents and metadata for tabular data.
`FileUploadRequest`	FileUploadRequest requests to upload the contents and metadata for binary (image + file) data.
`FileUploadResponse`	FileUploadResponse returns the file id of the uploaded contents and metadata for binary (image + file) data.
`StreamingDataCaptureUploadRequest`	StreamingDataCaptureUploadRequest requests to upload the contents and metadata for streaming binary (image + file) data.
`StreamingDataCaptureUploadResponse`	StreamingDataCaptureUploadResponse returns the file id of the uploaded contents and metadata for streaming binary (image + file) data.
`SensorMetadata`	SensorMetadata contains the time the sensor data was requested and was
`SensorData`	SensorData contains the contents and metadata for tabular data.
`FileData`	FileData contains the contents of binary (image + file) data.
`UploadMetadata`	UploadMetadata contains the metadata for binary (image + file) data.
`CaptureInterval`	CaptureInterval specifies the start and end times of the data capture.
`DataCaptureMetadata`	DataCaptureMetadata contains the metadata for data captured by collectors.
`DataCaptureUploadMetadata`	DataCaptureUploadMetadata contains the metadata for streaming binary (image + file) data.

Module Contents

viam.gen.app.datasync.v1.data_sync_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.datasync.v1.data_sync_pb2.MimeType: Bases: _MimeType

viam.gen.app.datasync.v1.data_sync_pb2.MIME_TYPE_UNSPECIFIED: MimeType

viam.gen.app.datasync.v1.data_sync_pb2.MIME_TYPE_IMAGE_JPEG: MimeType

viam.gen.app.datasync.v1.data_sync_pb2.MIME_TYPE_IMAGE_PNG: MimeType

viam.gen.app.datasync.v1.data_sync_pb2.MIME_TYPE_APPLICATION_PCD: MimeType

viam.gen.app.datasync.v1.data_sync_pb2.MIME_TYPE_VIDEO_MP4: MimeType

type viam.gen.app.datasync.v1.data_sync_pb2.Global___MimeType = MimeType

class viam.gen.app.datasync.v1.data_sync_pb2.DataType

Bases: _DataType

DataType specifies the type of data uploaded.

viam.gen.app.datasync.v1.data_sync_pb2.DATA_TYPE_UNSPECIFIED: DataType

viam.gen.app.datasync.v1.data_sync_pb2.DATA_TYPE_BINARY_SENSOR: DataType

viam.gen.app.datasync.v1.data_sync_pb2.DATA_TYPE_TABULAR_SENSOR: DataType

viam.gen.app.datasync.v1.data_sync_pb2.DATA_TYPE_FILE: DataType

type viam.gen.app.datasync.v1.data_sync_pb2.Global___DataType = DataType

class viam.gen.app.datasync.v1.data_sync_pb2.DataCaptureUploadRequest(*, metadata: Global___UploadMetadata | None = ..., sensor_contents: collections.abc.Iterable[Global___SensorData] | None = ...)

Bases: google.protobuf.message.Message

DataCaptureUploadRequest requests to upload the contents and metadata for tabular data.

metadata() → Global___UploadMetadata

sensor_contents() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___SensorData]

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.datasync.v1.data_sync_pb2.Global___DataCaptureUploadRequest = DataCaptureUploadRequest

class viam.gen.app.datasync.v1.data_sync_pb2.DataCaptureUploadResponse(*, file_id: str = ..., binary_data_id: str = ...)

Bases: google.protobuf.message.Message

DataCaptureUploadResponse returns the file id of the uploaded contents and metadata for tabular data.

file_id: str

binary_data_id: str

type viam.gen.app.datasync.v1.data_sync_pb2.Global___DataCaptureUploadResponse = DataCaptureUploadResponse

class viam.gen.app.datasync.v1.data_sync_pb2.FileUploadRequest(*, metadata: Global___UploadMetadata | None = ..., file_contents: Global___FileData | None = ...)

Bases: google.protobuf.message.Message

FileUploadRequest requests to upload the contents and metadata for binary (image + file) data. The first packet must be the UploadMetadata associated with the binary data.

metadata() → Global___UploadMetadata

file_contents() → Global___FileData

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_upload_packet) → _WhichOneofReturnType_upload_packet | 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.datasync.v1.data_sync_pb2.Global___FileUploadRequest = FileUploadRequest

class viam.gen.app.datasync.v1.data_sync_pb2.FileUploadResponse(*, file_id: str = ..., binary_data_id: str = ...)

Bases: google.protobuf.message.Message

FileUploadResponse returns the file id of the uploaded contents and metadata for binary (image + file) data.

file_id() → str

binary_data_id: str

type viam.gen.app.datasync.v1.data_sync_pb2.Global___FileUploadResponse = FileUploadResponse

class viam.gen.app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadRequest(*, metadata: Global___DataCaptureUploadMetadata | None = ..., data: bytes = ...)

Bases: google.protobuf.message.Message

StreamingDataCaptureUploadRequest requests to upload the contents and metadata for streaming binary (image + file) data. The first packet must be the DataCaptureUploadMetadata associated with the data.

data: bytes

metadata() → Global___DataCaptureUploadMetadata

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_upload_packet) → _WhichOneofReturnType_upload_packet | 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.datasync.v1.data_sync_pb2.Global___StreamingDataCaptureUploadRequest = StreamingDataCaptureUploadRequest

class viam.gen.app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadResponse(*, file_id: str = ..., binary_data_id: str = ...)

Bases: google.protobuf.message.Message

StreamingDataCaptureUploadResponse returns the file id of the uploaded contents and metadata for streaming binary (image + file) data.

file_id() → str

binary_data_id: str

type viam.gen.app.datasync.v1.data_sync_pb2.Global___StreamingDataCaptureUploadResponse = StreamingDataCaptureUploadResponse

class viam.gen.app.datasync.v1.data_sync_pb2.SensorMetadata(*, time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ..., mime_type: Global___MimeType = ..., annotations: app.data.v1.data_pb2.Annotations | None = ...)

Bases: google.protobuf.message.Message

SensorMetadata contains the time the sensor data was requested and was received.

mime_type() → Global___MimeType

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

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

annotations() → app.data.v1.data_pb2.Annotations

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.datasync.v1.data_sync_pb2.Global___SensorMetadata = SensorMetadata

class viam.gen.app.datasync.v1.data_sync_pb2.SensorData(*, metadata: Global___SensorMetadata | None = ..., struct: google.protobuf.struct_pb2.Struct | None = ..., binary: bytes = ...)

Bases: google.protobuf.message.Message

SensorData contains the contents and metadata for tabular data.

binary: bytes

metadata() → Global___SensorMetadata

struct() → 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_data) → _WhichOneofReturnType_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.datasync.v1.data_sync_pb2.Global___SensorData = SensorData

class viam.gen.app.datasync.v1.data_sync_pb2.FileData(*, data: bytes = ...)

Bases: google.protobuf.message.Message

FileData contains the contents of binary (image + file) data.

data: bytes

type viam.gen.app.datasync.v1.data_sync_pb2.Global___FileData = FileData

class viam.gen.app.datasync.v1.data_sync_pb2.UploadMetadata(*, part_id: str = ..., component_type: str = ..., component_name: str = ..., method_name: str = ..., type: Global___DataType = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., file_name: str = ..., file_extension: str = ..., file_create_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., file_modify_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., tags: collections.abc.Iterable[str] | None = ..., dataset_ids: collections.abc.Iterable[str] | None = ..., mime_type: str = ...)

Bases: google.protobuf.message.Message

UploadMetadata contains the metadata for binary (image + file) data.

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.

part_id: str

component_type: str

component_name: str

method_name: str

type: Global___DataType

file_name: str

file_extension: str

mime_type: str

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

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

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

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

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.datasync.v1.data_sync_pb2.Global___UploadMetadata = UploadMetadata

class viam.gen.app.datasync.v1.data_sync_pb2.CaptureInterval(*, start: google.protobuf.timestamp_pb2.Timestamp | None = ..., end: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

CaptureInterval specifies the start and end times of the data capture.

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.datasync.v1.data_sync_pb2.Global___CaptureInterval = CaptureInterval

class viam.gen.app.datasync.v1.data_sync_pb2.DataCaptureMetadata(*, component_type: str = ..., component_name: str = ..., method_name: str = ..., type: Global___DataType = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., file_extension: str = ..., tags: collections.abc.Iterable[str] | None = ..., mime_type: str = ...)

Bases: google.protobuf.message.Message

DataCaptureMetadata contains the metadata for data captured by collectors.

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.

component_type: str

component_name: str

method_name: str

type: Global___DataType

file_extension: 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.datasync.v1.data_sync_pb2.Global___DataCaptureMetadata = DataCaptureMetadata

class viam.gen.app.datasync.v1.data_sync_pb2.DataCaptureUploadMetadata(*, upload_metadata: Global___UploadMetadata | None = ..., sensor_metadata: Global___SensorMetadata | None = ...)

Bases: google.protobuf.message.Message

DataCaptureUploadMetadata contains the metadata for streaming binary (image + file) data.

upload_metadata() → Global___UploadMetadata

sensor_metadata() → Global___SensorMetadata

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.datasync.v1.data_sync_pb2.Global___DataCaptureUploadMetadata = DataCaptureUploadMetadata

`DESCRIPTOR`
`MIME_TYPE_UNSPECIFIED`
`MIME_TYPE_IMAGE_JPEG`
`MIME_TYPE_IMAGE_PNG`
`MIME_TYPE_APPLICATION_PCD`
`MIME_TYPE_VIDEO_MP4`
`Global___MimeType`
`DATA_TYPE_UNSPECIFIED`
`DATA_TYPE_BINARY_SENSOR`
`DATA_TYPE_TABULAR_SENSOR`
`DATA_TYPE_FILE`
`Global___DataType`
`Global___DataCaptureUploadRequest`
`Global___DataCaptureUploadResponse`
`Global___FileUploadRequest`
`Global___FileUploadResponse`
`Global___StreamingDataCaptureUploadRequest`
`Global___StreamingDataCaptureUploadResponse`
`Global___SensorMetadata`
`Global___SensorData`
`Global___FileData`
`Global___UploadMetadata`
`Global___CaptureInterval`
`Global___DataCaptureMetadata`
`Global___DataCaptureUploadMetadata`

viam.gen.app.datasync.v1.data_sync_pb2

Attributes

Classes

Module Contents