`viam.proto.app.datasync`

@generated by Viam. Do not edit manually!

Package Contents

Classes

`DataSyncServiceBase`	Helper class that provides a standard way to create an ABC using
`DataSyncServiceStub`
`UnimplementedDataSyncServiceBase`	Helper class that provides a standard way to create an ABC using
`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.
`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.
`DataType`	DataType specifies the type of data uploaded.
`FileData`	FileData contains the contents of binary (image + file) 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.
`SensorData`	SensorData contains the contents and metadata for tabular data.
`SensorMetadata`	SensorMetadata contains the time the sensor data was requested and was received.
`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.
`UploadMetadata`	UploadMetadata contains the metadata for binary (image + file) data.

class viam.proto.app.datasync.DataSyncServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async DataCaptureUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.DataCaptureUploadRequest, app.datasync.v1.data_sync_pb2.DataCaptureUploadResponse]) → None[source]

abstract async FileUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.FileUploadRequest, app.datasync.v1.data_sync_pb2.FileUploadResponse]) → None[source]

abstract async StreamingDataCaptureUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadRequest, app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadResponse]) → None[source]

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.app.datasync.DataSyncServiceStub(channel: grpclib.client.Channel)[source]

class viam.proto.app.datasync.UnimplementedDataSyncServiceBase[source]

Bases: DataSyncServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async DataCaptureUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.DataCaptureUploadRequest, app.datasync.v1.data_sync_pb2.DataCaptureUploadResponse]) → None[source]

async FileUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.FileUploadRequest, app.datasync.v1.data_sync_pb2.FileUploadResponse]) → None[source]

async StreamingDataCaptureUpload(stream: grpclib.server.Stream[app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadRequest, app.datasync.v1.data_sync_pb2.StreamingDataCaptureUploadResponse]) → None[source]

class viam.proto.app.datasync.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.

property start: google.protobuf.timestamp_pb2.Timestamp

property end: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal[end, b'end', start, b'start']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.datasync.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 = ...)

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.

property value: google.protobuf.any_pb2.Any

key: str

HasField(field_name: Literal[value, b'value']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

property method_parameters: google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]

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

component_type: str

component_name: str

method_name: str

type: global___DataType

file_extension: str

class viam.proto.app.datasync.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.

property upload_metadata: global___UploadMetadata

property sensor_metadata: global___SensorMetadata

HasField(field_name: Literal[sensor_metadata, b'sensor_metadata', upload_metadata, b'upload_metadata']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.datasync.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.

property metadata: global___UploadMetadata

property sensor_contents: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SensorData]

HasField(field_name: Literal[metadata, b'metadata']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.datasync.DataCaptureUploadResponse(*, file_id: str = ...)

Bases: google.protobuf.message.Message

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

file_id: str

class viam.proto.app.datasync.DataType

Bases: _DataType

DataType specifies the type of data uploaded.

class viam.proto.app.datasync.FileData(*, data: bytes = ...)

Bases: google.protobuf.message.Message

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

data: bytes

class viam.proto.app.datasync.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.

property metadata: global___UploadMetadata

property file_contents: global___FileData

HasField(field_name: Literal[file_contents, b'file_contents', metadata, b'metadata', upload_packet, b'upload_packet']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[upload_packet, b'upload_packet']) → Literal[metadata, file_contents] | 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

class viam.proto.app.datasync.FileUploadResponse(*, file_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

class viam.proto.app.datasync.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.

property metadata: global___SensorMetadata

property struct: google.protobuf.struct_pb2.Struct

binary: bytes

HasField(field_name: Literal[binary, b'binary', data, b'data', metadata, b'metadata', struct, b'struct']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[data, b'data']) → Literal[struct, binary] | 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

class viam.proto.app.datasync.SensorMetadata(*, time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

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

property time_requested: google.protobuf.timestamp_pb2.Timestamp

property time_received: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal[time_received, b'time_received', time_requested, b'time_requested']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.datasync.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.

property metadata: global___DataCaptureUploadMetadata

data: bytes

HasField(field_name: Literal[data, b'data', metadata, b'metadata', upload_packet, b'upload_packet']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[upload_packet, b'upload_packet']) → Literal[metadata, 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

class viam.proto.app.datasync.StreamingDataCaptureUploadResponse(*, file_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

class viam.proto.app.datasync.UploadMetadata(*, part_id: str = ..., component_type: str = ..., component_name: str = ..., method_name: str = ..., type: global___DataType = ..., file_name: str = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., file_extension: str = ..., tags: collections.abc.Iterable[str] | None = ...)

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.

property value: google.protobuf.any_pb2.Any

key: str

HasField(field_name: Literal[value, b'value']) → bool

Checks if a certain field is set for the message.

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

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

property method_parameters: google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]

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

part_id: str

component_type: str

component_name: str

method_name: str

type: global___DataType

file_name: str

file_extension: str

viam.proto.app.datasync

Package Contents

Classes

`viam.proto.app.datasync`