viam.gen.module.v1.module_pb2

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

Attributes

DESCRIPTOR

global___AddResourceRequest

global___AddResourceResponse

global___ReconfigureResourceRequest

global___ReconfigureResourceResponse

global___RemoveResourceRequest

global___RemoveResourceResponse

global___HandlerDefinition

global___HandlerMap

global___ReadyRequest

global___ReadyResponse

global___ValidateConfigRequest

global___ValidateConfigResponse

Classes

AddResourceRequest

Abstract base class for protocol messages.

AddResourceResponse

Abstract base class for protocol messages.

ReconfigureResourceRequest

Abstract base class for protocol messages.

ReconfigureResourceResponse

Abstract base class for protocol messages.

RemoveResourceRequest

Abstract base class for protocol messages.

RemoveResourceResponse

Abstract base class for protocol messages.

HandlerDefinition

Abstract base class for protocol messages.

HandlerMap

Abstract base class for protocol messages.

ReadyRequest

Abstract base class for protocol messages.

ReadyResponse

Abstract base class for protocol messages.

ValidateConfigRequest

Abstract base class for protocol messages.

ValidateConfigResponse

Abstract base class for protocol messages.

Module Contents

viam.gen.module.v1.module_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.module.v1.module_pb2.AddResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | 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 config: viam.gen.app.v1.robot_pb2.ComponentConfig
property dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['config', b'config']) 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.module.v1.module_pb2.global___AddResourceRequest
class viam.gen.module.v1.module_pb2.AddResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

viam.gen.module.v1.module_pb2.global___AddResourceResponse
class viam.gen.module.v1.module_pb2.ReconfigureResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | 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 config: viam.gen.app.v1.robot_pb2.ComponentConfig
property dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['config', b'config']) 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.module.v1.module_pb2.global___ReconfigureResourceRequest
class viam.gen.module.v1.module_pb2.ReconfigureResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

viam.gen.module.v1.module_pb2.global___ReconfigureResourceResponse
class viam.gen.module.v1.module_pb2.RemoveResourceRequest(*, name: 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.

name: str
viam.gen.module.v1.module_pb2.global___RemoveResourceRequest
class viam.gen.module.v1.module_pb2.RemoveResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

viam.gen.module.v1.module_pb2.global___RemoveResourceResponse
class viam.gen.module.v1.module_pb2.HandlerDefinition(*, subtype: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype | None = ..., models: collections.abc.Iterable[str] | 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 subtype: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype
property models: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['subtype', b'subtype']) 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.module.v1.module_pb2.global___HandlerDefinition
class viam.gen.module.v1.module_pb2.HandlerMap(*, handlers: collections.abc.Iterable[global___HandlerDefinition] | 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 handlers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___HandlerDefinition]
viam.gen.module.v1.module_pb2.global___HandlerMap
class viam.gen.module.v1.module_pb2.ReadyRequest(*, parent_address: str = ..., webrtc_offer: 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.

parent_address: str
webrtc_offer: str
viam.gen.module.v1.module_pb2.global___ReadyRequest
class viam.gen.module.v1.module_pb2.ReadyResponse(*, ready: bool = ..., handlermap: global___HandlerMap | None = ..., webrtc_answer: 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.

ready: bool
webrtc_answer: str
property handlermap: global___HandlerMap
HasField(field_name: Literal['handlermap', b'handlermap']) 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.module.v1.module_pb2.global___ReadyResponse
class viam.gen.module.v1.module_pb2.ValidateConfigRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | 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 config: viam.gen.app.v1.robot_pb2.ComponentConfig
HasField(field_name: Literal['config', b'config']) 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.module.v1.module_pb2.global___ValidateConfigRequest
class viam.gen.module.v1.module_pb2.ValidateConfigResponse(*, dependencies: collections.abc.Iterable[str] | 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 dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
viam.gen.module.v1.module_pb2.global___ValidateConfigResponse