viam.gen.robot.v1.robot_pb2

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

Attributes

`DESCRIPTOR`
`PEER_CONNECTION_TYPE_UNSPECIFIED`
`PEER_CONNECTION_TYPE_GRPC`
`PEER_CONNECTION_TYPE_WEBRTC`
`Global___PeerConnectionType`
`Global___SendTracesRequest`
`Global___SendTracesResponse`
`Global___TunnelRequest`
`Global___TunnelResponse`
`Global___ListTunnelsRequest`
`Global___ListTunnelsResponse`
`Global___Tunnel`
`Global___FrameSystemConfig`
`Global___FrameSystemConfigRequest`
`Global___FrameSystemConfigResponse`
`Global___TransformPoseRequest`
`Global___TransformPoseResponse`
`Global___TransformPCDRequest`
`Global___TransformPCDResponse`
`Global___ResourceNamesRequest`
`Global___ResourceNamesResponse`
`Global___ResourceRPCSubtype`
`Global___ResourceRPCSubtypesRequest`
`Global___ResourceRPCSubtypesResponse`
`Global___Operation`
`Global___GetOperationsRequest`
`Global___GetOperationsResponse`
`Global___CancelOperationRequest`
`Global___CancelOperationResponse`
`Global___BlockForOperationRequest`
`Global___BlockForOperationResponse`
`Global___PeerConnectionInfo`
`Global___Session`
`Global___GetSessionsRequest`
`Global___GetSessionsResponse`
`Global___ModuleModel`
`Global___GetModelsFromModulesRequest`
`Global___GetModelsFromModulesResponse`
`Global___Status`
`Global___GetStatusRequest`
`Global___GetStatusResponse`
`Global___StreamStatusRequest`
`Global___StreamStatusResponse`
`Global___StopExtraParameters`
`Global___StopAllRequest`
`Global___StopAllResponse`
`Global___StartSessionRequest`
`Global___StartSessionResponse`
`Global___SendSessionHeartbeatRequest`
`Global___SendSessionHeartbeatResponse`
`Global___LogRequest`
`Global___LogResponse`
`Global___GetCloudMetadataRequest`
`Global___GetCloudMetadataResponse`
`Global___RestartModuleRequest`
`Global___RestartModuleResponse`
`Global___ShutdownRequest`
`Global___ShutdownResponse`
`Global___GetMachineStatusRequest`
`Global___GetMachineStatusResponse`
`Global___JobStatus`
`Global___ResourceStatus`
`Global___ConfigStatus`
`Global___GetVersionRequest`
`Global___GetVersionResponse`
`Global___GetPoseRequest`
`Global___GetPoseResponse`

Classes

`PeerConnectionType`
`SendTracesRequest`	Abstract base class for protocol messages.
`SendTracesResponse`	Abstract base class for protocol messages.
`TunnelRequest`	Abstract base class for protocol messages.
`TunnelResponse`	Abstract base class for protocol messages.
`ListTunnelsRequest`	Abstract base class for protocol messages.
`ListTunnelsResponse`	Abstract base class for protocol messages.
`Tunnel`	Abstract base class for protocol messages.
`FrameSystemConfig`	Abstract base class for protocol messages.
`FrameSystemConfigRequest`	Abstract base class for protocol messages.
`FrameSystemConfigResponse`	Abstract base class for protocol messages.
`TransformPoseRequest`	Abstract base class for protocol messages.
`TransformPoseResponse`	Abstract base class for protocol messages.
`TransformPCDRequest`	Abstract base class for protocol messages.
`TransformPCDResponse`	Abstract base class for protocol messages.
`ResourceNamesRequest`	Abstract base class for protocol messages.
`ResourceNamesResponse`	Abstract base class for protocol messages.
`ResourceRPCSubtype`	Abstract base class for protocol messages.
`ResourceRPCSubtypesRequest`	Abstract base class for protocol messages.
`ResourceRPCSubtypesResponse`	Abstract base class for protocol messages.
`Operation`	Abstract base class for protocol messages.
`GetOperationsRequest`	Abstract base class for protocol messages.
`GetOperationsResponse`	Abstract base class for protocol messages.
`CancelOperationRequest`	Abstract base class for protocol messages.
`CancelOperationResponse`	Abstract base class for protocol messages.
`BlockForOperationRequest`	Abstract base class for protocol messages.
`BlockForOperationResponse`	Abstract base class for protocol messages.
`PeerConnectionInfo`	Abstract base class for protocol messages.
`Session`	Abstract base class for protocol messages.
`GetSessionsRequest`	Abstract base class for protocol messages.
`GetSessionsResponse`	Abstract base class for protocol messages.
`ModuleModel`	Abstract base class for protocol messages.
`GetModelsFromModulesRequest`	Abstract base class for protocol messages.
`GetModelsFromModulesResponse`	Abstract base class for protocol messages.
`Status`	Abstract base class for protocol messages.
`GetStatusRequest`	Abstract base class for protocol messages.
`GetStatusResponse`	Abstract base class for protocol messages.
`StreamStatusRequest`	Abstract base class for protocol messages.
`StreamStatusResponse`	Abstract base class for protocol messages.
`StopExtraParameters`	Abstract base class for protocol messages.
`StopAllRequest`	Abstract base class for protocol messages.
`StopAllResponse`	Abstract base class for protocol messages.
`StartSessionRequest`	Abstract base class for protocol messages.
`StartSessionResponse`	Abstract base class for protocol messages.
`SendSessionHeartbeatRequest`	Abstract base class for protocol messages.
`SendSessionHeartbeatResponse`	Abstract base class for protocol messages.
`LogRequest`	Abstract base class for protocol messages.
`LogResponse`	Abstract base class for protocol messages.
`GetCloudMetadataRequest`	Abstract base class for protocol messages.
`GetCloudMetadataResponse`	Abstract base class for protocol messages.
`RestartModuleRequest`	Abstract base class for protocol messages.
`RestartModuleResponse`	Abstract base class for protocol messages.
`ShutdownRequest`	Abstract base class for protocol messages.
`ShutdownResponse`	Abstract base class for protocol messages.
`GetMachineStatusRequest`	Abstract base class for protocol messages.
`GetMachineStatusResponse`	Abstract base class for protocol messages.
`JobStatus`	Abstract base class for protocol messages.
`ResourceStatus`	Abstract base class for protocol messages.
`ConfigStatus`	Abstract base class for protocol messages.
`GetVersionRequest`	Abstract base class for protocol messages.
`GetVersionResponse`	Abstract base class for protocol messages.
`GetPoseRequest`	Abstract base class for protocol messages.
`GetPoseResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.robot.v1.robot_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.robot.v1.robot_pb2.PeerConnectionType: Bases: _PeerConnectionType

viam.gen.robot.v1.robot_pb2.PEER_CONNECTION_TYPE_UNSPECIFIED: PeerConnectionType

viam.gen.robot.v1.robot_pb2.PEER_CONNECTION_TYPE_GRPC: PeerConnectionType

viam.gen.robot.v1.robot_pb2.PEER_CONNECTION_TYPE_WEBRTC: PeerConnectionType

type viam.gen.robot.v1.robot_pb2.Global___PeerConnectionType = PeerConnectionType

class viam.gen.robot.v1.robot_pb2.SendTracesRequest(*, resource_spans: collections.abc.Iterable[opentelemetry.proto.trace.v1.trace_pb2.ResourceSpans] | 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.

resource_spans() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[opentelemetry.proto.trace.v1.trace_pb2.ResourceSpans]

type viam.gen.robot.v1.robot_pb2.Global___SendTracesRequest = SendTracesRequest

class viam.gen.robot.v1.robot_pb2.SendTracesResponse

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.robot.v1.robot_pb2.Global___SendTracesResponse = SendTracesResponse

class viam.gen.robot.v1.robot_pb2.TunnelRequest(*, destination_port: int = ..., data: bytes = ...)

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.

destination_port: int

data: bytes

type viam.gen.robot.v1.robot_pb2.Global___TunnelRequest = TunnelRequest

class viam.gen.robot.v1.robot_pb2.TunnelResponse(*, data: bytes = ...)

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.

data: bytes

type viam.gen.robot.v1.robot_pb2.Global___TunnelResponse = TunnelResponse

class viam.gen.robot.v1.robot_pb2.ListTunnelsRequest

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.robot.v1.robot_pb2.Global___ListTunnelsRequest = ListTunnelsRequest

class viam.gen.robot.v1.robot_pb2.ListTunnelsResponse(*, tunnels: collections.abc.Iterable[Global___Tunnel] | 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.

tunnels() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Tunnel]

type viam.gen.robot.v1.robot_pb2.Global___ListTunnelsResponse = ListTunnelsResponse

class viam.gen.robot.v1.robot_pb2.Tunnel(*, port: int = ..., connection_timeout: google.protobuf.duration_pb2.Duration | 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.

port: int

connection_timeout() → google.protobuf.duration_pb2.Duration

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.robot.v1.robot_pb2.Global___Tunnel = Tunnel

class viam.gen.robot.v1.robot_pb2.FrameSystemConfig(*, frame: common.v1.common_pb2.Transform | None = ..., kinematics: 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.

frame() → common.v1.common_pb2.Transform: this is an experimental API message

kinematics() → 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.robot.v1.robot_pb2.Global___FrameSystemConfig = FrameSystemConfig

class viam.gen.robot.v1.robot_pb2.FrameSystemConfigRequest(*, supplemental_transforms: collections.abc.Iterable[common.v1.common_pb2.Transform] | 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.

supplemental_transforms() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.Transform]: pose information on any additional reference frames that are needed to supplement the robot’s frame system

type viam.gen.robot.v1.robot_pb2.Global___FrameSystemConfigRequest = FrameSystemConfigRequest

class viam.gen.robot.v1.robot_pb2.FrameSystemConfigResponse(*, frame_system_configs: collections.abc.Iterable[Global___FrameSystemConfig] | 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.

frame_system_configs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FrameSystemConfig]

type viam.gen.robot.v1.robot_pb2.Global___FrameSystemConfigResponse = FrameSystemConfigResponse

class viam.gen.robot.v1.robot_pb2.TransformPoseRequest(*, source: common.v1.common_pb2.PoseInFrame | None = ..., destination: str = ..., supplemental_transforms: collections.abc.Iterable[common.v1.common_pb2.Transform] | 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.

destination: str: the reference frame into which the source pose should be transformed, if unset this defaults to the “world” reference frame

source() → common.v1.common_pb2.PoseInFrame: the original pose to transform along with the reference frame in which it was observed

supplemental_transforms() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.Transform]: pose information on any additional reference frames that are needed to perform the transform

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.robot.v1.robot_pb2.Global___TransformPoseRequest = TransformPoseRequest

class viam.gen.robot.v1.robot_pb2.TransformPoseResponse(*, pose: common.v1.common_pb2.PoseInFrame | 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.

pose() → common.v1.common_pb2.PoseInFrame

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.robot.v1.robot_pb2.Global___TransformPoseResponse = TransformPoseResponse

class viam.gen.robot.v1.robot_pb2.TransformPCDRequest(*, point_cloud_pcd: bytes = ..., source: str = ..., destination: 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.

point_cloud_pcd: bytes: the point clouds to transform. This should be in the PCD format, [encoded into bytes](https://pointclouds.org/documentation/tutorials/pcd_file_format.html).

source: str: the reference frame of the point cloud.

destination: str: the reference frame into which the source data should be transformed, if unset this defaults to the “world” reference frame. Do not move the robot between the generation of the initial pointcloud and the receipt of the transformed pointcloud because that will make the transformations inaccurate

type viam.gen.robot.v1.robot_pb2.Global___TransformPCDRequest = TransformPCDRequest

class viam.gen.robot.v1.robot_pb2.TransformPCDResponse(*, point_cloud_pcd: bytes = ...)

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.

point_cloud_pcd: bytes

type viam.gen.robot.v1.robot_pb2.Global___TransformPCDResponse = TransformPCDResponse

class viam.gen.robot.v1.robot_pb2.ResourceNamesRequest

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.robot.v1.robot_pb2.Global___ResourceNamesRequest = ResourceNamesRequest

class viam.gen.robot.v1.robot_pb2.ResourceNamesResponse(*, resources: collections.abc.Iterable[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.

resources() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.ResourceName]

type viam.gen.robot.v1.robot_pb2.Global___ResourceNamesResponse = ResourceNamesResponse

class viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype(*, subtype: common.v1.common_pb2.ResourceName | None = ..., proto_service: 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.

proto_service: str

subtype() → common.v1.common_pb2.ResourceName

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.robot.v1.robot_pb2.Global___ResourceRPCSubtype = ResourceRPCSubtype

class viam.gen.robot.v1.robot_pb2.ResourceRPCSubtypesRequest

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.robot.v1.robot_pb2.Global___ResourceRPCSubtypesRequest = ResourceRPCSubtypesRequest

class viam.gen.robot.v1.robot_pb2.ResourceRPCSubtypesResponse(*, resource_rpc_subtypes: collections.abc.Iterable[Global___ResourceRPCSubtype] | 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.

resource_rpc_subtypes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResourceRPCSubtype]

type viam.gen.robot.v1.robot_pb2.Global___ResourceRPCSubtypesResponse = ResourceRPCSubtypesResponse

class viam.gen.robot.v1.robot_pb2.Operation(*, id: str = ..., method: str = ..., arguments: google.protobuf.struct_pb2.Struct | None = ..., started: google.protobuf.timestamp_pb2.Timestamp | None = ..., session_id: 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.

id: str

method: str

session_id: str

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

started() → 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.

WhichOneof(oneof_group: _WhichOneofArgType__session_id) → _WhichOneofReturnType__session_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.robot.v1.robot_pb2.Global___Operation = Operation

class viam.gen.robot.v1.robot_pb2.GetOperationsRequest

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.robot.v1.robot_pb2.Global___GetOperationsRequest = GetOperationsRequest

class viam.gen.robot.v1.robot_pb2.GetOperationsResponse(*, operations: collections.abc.Iterable[Global___Operation] | 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.

operations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Operation]

type viam.gen.robot.v1.robot_pb2.Global___GetOperationsResponse = GetOperationsResponse

class viam.gen.robot.v1.robot_pb2.CancelOperationRequest(*, 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.robot.v1.robot_pb2.Global___CancelOperationRequest = CancelOperationRequest

class viam.gen.robot.v1.robot_pb2.CancelOperationResponse

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.robot.v1.robot_pb2.Global___CancelOperationResponse = CancelOperationResponse

class viam.gen.robot.v1.robot_pb2.BlockForOperationRequest(*, 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.robot.v1.robot_pb2.Global___BlockForOperationRequest = BlockForOperationRequest

class viam.gen.robot.v1.robot_pb2.BlockForOperationResponse

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.robot.v1.robot_pb2.Global___BlockForOperationResponse = BlockForOperationResponse

class viam.gen.robot.v1.robot_pb2.PeerConnectionInfo(*, type: Global___PeerConnectionType = ..., remote_address: str | None = ..., local_address: 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.

type: Global___PeerConnectionType

remote_address: str

local_address: 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__local_address) → _WhichOneofReturnType__local_address | None

WhichOneof(oneof_group: _WhichOneofArgType__remote_address) → _WhichOneofReturnType__remote_address | 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.robot.v1.robot_pb2.Global___PeerConnectionInfo = PeerConnectionInfo

class viam.gen.robot.v1.robot_pb2.Session(*, id: str = ..., peer_connection_info: Global___PeerConnectionInfo | 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

peer_connection_info() → Global___PeerConnectionInfo

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__peer_connection_info) → _WhichOneofReturnType__peer_connection_info | 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.robot.v1.robot_pb2.Global___Session = Session

class viam.gen.robot.v1.robot_pb2.GetSessionsRequest

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.robot.v1.robot_pb2.Global___GetSessionsRequest = GetSessionsRequest

class viam.gen.robot.v1.robot_pb2.GetSessionsResponse(*, sessions: collections.abc.Iterable[Global___Session] | 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.

sessions() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Session]

type viam.gen.robot.v1.robot_pb2.Global___GetSessionsResponse = GetSessionsResponse

class viam.gen.robot.v1.robot_pb2.ModuleModel(*, module_name: str = ..., model: str = ..., api: str = ..., from_local_module: bool = ...)

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.

module_name: str

model: str

api: str

from_local_module: bool

type viam.gen.robot.v1.robot_pb2.Global___ModuleModel = ModuleModel

class viam.gen.robot.v1.robot_pb2.GetModelsFromModulesRequest

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.robot.v1.robot_pb2.Global___GetModelsFromModulesRequest = GetModelsFromModulesRequest

class viam.gen.robot.v1.robot_pb2.GetModelsFromModulesResponse(*, models: collections.abc.Iterable[Global___ModuleModel] | 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.

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ModuleModel]

type viam.gen.robot.v1.robot_pb2.Global___GetModelsFromModulesResponse = GetModelsFromModulesResponse

class viam.gen.robot.v1.robot_pb2.Status(*, name: common.v1.common_pb2.ResourceName | None = ..., status: google.protobuf.struct_pb2.Struct | None = ..., last_reconfigured: 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.

name() → common.v1.common_pb2.ResourceName

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

last_reconfigured() → 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.robot.v1.robot_pb2.Global___Status = Status

class viam.gen.robot.v1.robot_pb2.GetStatusRequest(*, resource_names: collections.abc.Iterable[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.

resource_names() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.ResourceName]

type viam.gen.robot.v1.robot_pb2.Global___GetStatusRequest = GetStatusRequest

class viam.gen.robot.v1.robot_pb2.GetStatusResponse(*, status: collections.abc.Iterable[Global___Status] | 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.

status() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Status]

type viam.gen.robot.v1.robot_pb2.Global___GetStatusResponse = GetStatusResponse

class viam.gen.robot.v1.robot_pb2.StreamStatusRequest(*, resource_names: collections.abc.Iterable[common.v1.common_pb2.ResourceName] | None = ..., every: google.protobuf.duration_pb2.Duration | 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.

resource_names() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.ResourceName]

every() → google.protobuf.duration_pb2.Duration: how often to send a new status.

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.robot.v1.robot_pb2.Global___StreamStatusRequest = StreamStatusRequest

class viam.gen.robot.v1.robot_pb2.StreamStatusResponse(*, status: collections.abc.Iterable[Global___Status] | 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.

status() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Status]

type viam.gen.robot.v1.robot_pb2.Global___StreamStatusResponse = StreamStatusResponse

class viam.gen.robot.v1.robot_pb2.StopExtraParameters(*, name: common.v1.common_pb2.ResourceName | None = ..., params: 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.

name() → common.v1.common_pb2.ResourceName

params() → 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.robot.v1.robot_pb2.Global___StopExtraParameters = StopExtraParameters

class viam.gen.robot.v1.robot_pb2.StopAllRequest(*, extra: collections.abc.Iterable[Global___StopExtraParameters] | 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.

extra() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___StopExtraParameters]

type viam.gen.robot.v1.robot_pb2.Global___StopAllRequest = StopAllRequest

class viam.gen.robot.v1.robot_pb2.StopAllResponse

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.robot.v1.robot_pb2.Global___StopAllResponse = StopAllResponse

class viam.gen.robot.v1.robot_pb2.StartSessionRequest(*, resume: 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.

resume: str: resume can be used to attempt to continue a stream after a disconnection event. If a session is not found, a new one will be created and returned.

type viam.gen.robot.v1.robot_pb2.Global___StartSessionRequest = StartSessionRequest

class viam.gen.robot.v1.robot_pb2.StartSessionResponse(*, id: str = ..., heartbeat_window: google.protobuf.duration_pb2.Duration | 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

heartbeat_window() → google.protobuf.duration_pb2.Duration

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.robot.v1.robot_pb2.Global___StartSessionResponse = StartSessionResponse

class viam.gen.robot.v1.robot_pb2.SendSessionHeartbeatRequest(*, 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.robot.v1.robot_pb2.Global___SendSessionHeartbeatRequest = SendSessionHeartbeatRequest

class viam.gen.robot.v1.robot_pb2.SendSessionHeartbeatResponse

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.robot.v1.robot_pb2.Global___SendSessionHeartbeatResponse = SendSessionHeartbeatResponse

class viam.gen.robot.v1.robot_pb2.LogRequest(*, logs: collections.abc.Iterable[common.v1.common_pb2.LogEntry] | 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.

logs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.LogEntry]

type viam.gen.robot.v1.robot_pb2.Global___LogRequest = LogRequest

class viam.gen.robot.v1.robot_pb2.LogResponse

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.robot.v1.robot_pb2.Global___LogResponse = LogResponse

class viam.gen.robot.v1.robot_pb2.GetCloudMetadataRequest

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.robot.v1.robot_pb2.Global___GetCloudMetadataRequest = GetCloudMetadataRequest

class viam.gen.robot.v1.robot_pb2.GetCloudMetadataResponse(*, robot_part_id: str = ..., primary_org_id: str = ..., location_id: str = ..., machine_id: str = ..., machine_part_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.

robot_part_id() → str: Deprecated: use machine_part_id field.

primary_org_id: str

location_id: str

machine_id: str

machine_part_id: str

type viam.gen.robot.v1.robot_pb2.Global___GetCloudMetadataResponse = GetCloudMetadataResponse

class viam.gen.robot.v1.robot_pb2.RestartModuleRequest(*, module_id: str = ..., module_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.

module_id: str: ID is for registry modules, name for local modules

module_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_id_or_name) → _WhichOneofReturnType_id_or_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.robot.v1.robot_pb2.Global___RestartModuleRequest = RestartModuleRequest

class viam.gen.robot.v1.robot_pb2.RestartModuleResponse

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.robot.v1.robot_pb2.Global___RestartModuleResponse = RestartModuleResponse

class viam.gen.robot.v1.robot_pb2.ShutdownRequest

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.robot.v1.robot_pb2.Global___ShutdownRequest = ShutdownRequest

class viam.gen.robot.v1.robot_pb2.ShutdownResponse

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.robot.v1.robot_pb2.Global___ShutdownResponse = ShutdownResponse

class viam.gen.robot.v1.robot_pb2.GetMachineStatusRequest

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.robot.v1.robot_pb2.Global___GetMachineStatusRequest = GetMachineStatusRequest

class viam.gen.robot.v1.robot_pb2.GetMachineStatusResponse(*, resources: collections.abc.Iterable[Global___ResourceStatus] | None = ..., config: Global___ConfigStatus | None = ..., state: Global___GetMachineStatusResponse = ..., job_statuses: collections.abc.Iterable[Global___JobStatus] | 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 State: Bases: _State

STATE_UNSPECIFIED: GetMachineStatusResponse

STATE_INITIALIZING: GetMachineStatusResponse: the machine is reachable but still in the process of configuring initial modules and resources.

STATE_RUNNING: GetMachineStatusResponse: the machine has finished initializing.

state: Global___GetMachineStatusResponse.State.ValueType

resources() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResourceStatus]

config() → Global___ConfigStatus

job_statuses() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___JobStatus]

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.robot.v1.robot_pb2.Global___GetMachineStatusResponse = GetMachineStatusResponse

class viam.gen.robot.v1.robot_pb2.JobStatus(*, job_name: str = ..., recent_successful_runs: collections.abc.Iterable[google.protobuf.timestamp_pb2.Timestamp] | None = ..., recent_failed_runs: collections.abc.Iterable[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.

job_name: str

recent_successful_runs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.timestamp_pb2.Timestamp]

recent_failed_runs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.timestamp_pb2.Timestamp]

type viam.gen.robot.v1.robot_pb2.Global___JobStatus = JobStatus

class viam.gen.robot.v1.robot_pb2.ResourceStatus(*, name: common.v1.common_pb2.ResourceName | None = ..., state: Global___ResourceStatus = ..., last_updated: google.protobuf.timestamp_pb2.Timestamp | None = ..., revision: str = ..., error: str = ..., cloud_metadata: Global___GetCloudMetadataResponse | 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 State: Bases: _State

STATE_UNSPECIFIED: ResourceStatus

STATE_UNCONFIGURED: ResourceStatus: a newly created resource.

STATE_CONFIGURING: ResourceStatus: a resource that is being configured.

STATE_READY: ResourceStatus: a resource that has been successfully configured once, and is not re-configuring, being removed, or unhealthy.

STATE_REMOVING: ResourceStatus: a resource that is being removed from the robot.

STATE_UNHEALTHY: ResourceStatus: a resource that is in an unhealthy state.

state: Global___ResourceStatus.State.ValueType: current state.

revision: str: revision of the last config that successfully updated this resource.

error: str: error details for a resource. This is guaranteed to be null if the resource is ready and non-null if the resource unhealthy.

name() → common.v1.common_pb2.ResourceName: resource name.

last_updated() → google.protobuf.timestamp_pb2.Timestamp: state transition timestamp.

cloud_metadata() → Global___GetCloudMetadataResponse: infomation about resource orgID, locationID and partID

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__cloud_metadata) → _WhichOneofReturnType__cloud_metadata | 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.robot.v1.robot_pb2.Global___ResourceStatus = ResourceStatus

class viam.gen.robot.v1.robot_pb2.ConfigStatus(*, revision: str = ..., last_updated: 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.

revision: str: revision of the last config that the machine successfully ingested.

last_updated() → google.protobuf.timestamp_pb2.Timestamp: config ingestion 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.robot.v1.robot_pb2.Global___ConfigStatus = ConfigStatus

class viam.gen.robot.v1.robot_pb2.GetVersionRequest

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.robot.v1.robot_pb2.Global___GetVersionRequest = GetVersionRequest

class viam.gen.robot.v1.robot_pb2.GetVersionResponse(*, platform: str = ..., version: str = ..., api_version: 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.

platform: str: platform type of viam-server (ie. rdk or micro-rdk).

version: str: version of viam-server. If built without a version, it will be dev-<git hash>.

api_version: str

type viam.gen.robot.v1.robot_pb2.Global___GetVersionResponse = GetVersionResponse

class viam.gen.robot.v1.robot_pb2.GetPoseRequest(*, component_name: str = ..., destination_frame: str = ..., supplemental_transforms: collections.abc.Iterable[common.v1.common_pb2.Transform] | 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.

component_name: str: the component whose pose is being requested

destination_frame: str: the reference frame in which the component’s pose should be provided, if unset this defaults to the “world” reference frame

supplemental_transforms() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.Transform]: pose information on any additional reference frames that are needed to compute the component’s pose

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

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.robot.v1.robot_pb2.Global___GetPoseRequest = GetPoseRequest

class viam.gen.robot.v1.robot_pb2.GetPoseResponse(*, pose: common.v1.common_pb2.PoseInFrame | 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.

pose() → common.v1.common_pb2.PoseInFrame

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.robot.v1.robot_pb2.Global___GetPoseResponse = GetPoseResponse