viam.gen.service.sensors.v1.sensors_pb2

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

Module Contents

Classes

GetSensorsRequest	The sensors service messages are deprecated
GetSensorsResponse	Abstract base class for protocol messages.
GetReadingsRequest	Abstract base class for protocol messages.
Readings	Abstract base class for protocol messages.
GetReadingsResponse	Abstract base class for protocol messages.

Attributes

DESCRIPTOR
global___GetSensorsRequest
global___GetSensorsResponse
global___GetReadingsRequest
global___Readings
global___GetReadingsResponse

viam.gen.service.sensors.v1.sensors_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.service.sensors.v1.sensors_pb2.GetSensorsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

The sensors service messages are deprecated

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

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

Checks if a certain field is set for the message.

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

Parameters:

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

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

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

viam.gen.service.sensors.v1.sensors_pb2.global___GetSensorsRequest

class viam.gen.service.sensors.v1.sensors_pb2.GetSensorsResponse(*, sensor_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | 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 sensor_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

viam.gen.service.sensors.v1.sensors_pb2.global___GetSensorsResponse

class viam.gen.service.sensors.v1.sensors_pb2.GetReadingsRequest(*, name: str = ..., sensor_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | None = ..., extra: google.protobuf.struct_pb2.Struct | 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 sensor_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str

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

Checks if a certain field is set for the message.

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

Parameters:

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

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

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

viam.gen.service.sensors.v1.sensors_pb2.global___GetReadingsRequest

class viam.gen.service.sensors.v1.sensors_pb2.Readings(*, name: viam.gen.common.v1.common_pb2.ResourceName | None = ..., readings: collections.abc.Mapping[str, google.protobuf.struct_pb2.Value] | 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.

class ReadingsEntry(*, key: str = ..., value: google.protobuf.struct_pb2.Value | 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.struct_pb2.Value

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 name: viam.gen.common.v1.common_pb2.ResourceName

property readings: google.protobuf.internal.containers.MessageMap[str, google.protobuf.struct_pb2.Value]

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

Checks if a certain field is set for the message.

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

Parameters:

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

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

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

viam.gen.service.sensors.v1.sensors_pb2.global___Readings

class viam.gen.service.sensors.v1.sensors_pb2.GetReadingsResponse(*, readings: collections.abc.Iterable[global___Readings] | 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 readings: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Readings]

viam.gen.service.sensors.v1.sensors_pb2.global___GetReadingsResponse