viam.gen.robot.v1.robot_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_file
Attributes
Classes
this is an experimental API message |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Discovery |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
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
- viam.gen.robot.v1.robot_pb2.global___PeerConnectionType
- class viam.gen.robot.v1.robot_pb2.FrameSystemConfig(*, frame: viam.gen.common.v1.common_pb2.Transform | None = ..., kinematics: google.protobuf.struct_pb2.Struct | None = ...)
Bases:
google.protobuf.message.Message
this is an experimental API message
- property frame: viam.gen.common.v1.common_pb2.Transform
- property kinematics: google.protobuf.struct_pb2.Struct
- HasField(field_name: Literal['frame', b'frame', 'kinematics', b'kinematics']) 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.robot.v1.robot_pb2.global___FrameSystemConfig
- class viam.gen.robot.v1.robot_pb2.FrameSystemConfigRequest(*, supplemental_transforms: collections.abc.Iterable[viam.gen.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.
- property supplemental_transforms: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.Transform]
pose information on any additional reference frames that are needed to supplement the robot’s frame system
- viam.gen.robot.v1.robot_pb2.global___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.
- property frame_system_configs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FrameSystemConfig]
- viam.gen.robot.v1.robot_pb2.global___FrameSystemConfigResponse
- class viam.gen.robot.v1.robot_pb2.TransformPoseRequest(*, source: viam.gen.common.v1.common_pb2.PoseInFrame | None = ..., destination: str = ..., supplemental_transforms: collections.abc.Iterable[viam.gen.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
- property source: viam.gen.common.v1.common_pb2.PoseInFrame
the original pose to transform along with the reference frame in which it was observed
- property supplemental_transforms: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.Transform]
pose information on any additional reference frames that are needed to perform the transform
- HasField(field_name: Literal['source', b'source']) 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.robot.v1.robot_pb2.global___TransformPoseRequest
- class viam.gen.robot.v1.robot_pb2.TransformPoseResponse(*, pose: viam.gen.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.
- property pose: viam.gen.common.v1.common_pb2.PoseInFrame
- HasField(field_name: Literal['pose', b'pose']) 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.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___ResourceNamesRequest
- class viam.gen.robot.v1.robot_pb2.ResourceNamesResponse(*, resources: 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 resources: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]
- viam.gen.robot.v1.robot_pb2.global___ResourceNamesResponse
- class viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype(*, subtype: viam.gen.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
- property subtype: viam.gen.common.v1.common_pb2.ResourceName
- 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.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- property resource_rpc_subtypes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceRPCSubtype]
- viam.gen.robot.v1.robot_pb2.global___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
- property arguments: google.protobuf.struct_pb2.Struct
- property started: google.protobuf.timestamp_pb2.Timestamp
- HasField(field_name: Literal['_session_id', b'_session_id', 'arguments', b'arguments', 'session_id', b'session_id', 'started', b'started']) 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['_session_id', b'_session_id']) Literal['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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- property operations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Operation]
- viam.gen.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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: Literal['_local_address', b'_local_address', '_remote_address', b'_remote_address', 'local_address', b'local_address', 'remote_address', b'remote_address']) 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['_local_address', b'_local_address']) Literal['local_address'] | None
- WhichOneof(oneof_group: Literal['_remote_address', b'_remote_address']) Literal['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
- viam.gen.robot.v1.robot_pb2.global___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
- property peer_connection_info: global___PeerConnectionInfo
- HasField(field_name: Literal['_peer_connection_info', b'_peer_connection_info', 'peer_connection_info', b'peer_connection_info']) 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['_peer_connection_info', b'_peer_connection_info']) Literal['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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Session]
- viam.gen.robot.v1.robot_pb2.global___GetSessionsResponse
- class viam.gen.robot.v1.robot_pb2.DiscoveryQuery(*, subtype: str = ..., model: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)
Bases:
google.protobuf.message.Message
Discovery
- subtype: str
- model: str
- property extra: google.protobuf.struct_pb2.Struct
- 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.robot.v1.robot_pb2.global___DiscoveryQuery
- class viam.gen.robot.v1.robot_pb2.Discovery(*, query: global___DiscoveryQuery | None = ..., results: 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 query: global___DiscoveryQuery
- property results: google.protobuf.struct_pb2.Struct
- HasField(field_name: Literal['query', b'query', 'results', b'results']) 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.robot.v1.robot_pb2.global___Discovery
- class viam.gen.robot.v1.robot_pb2.DiscoverComponentsRequest(*, queries: collections.abc.Iterable[global___DiscoveryQuery] | 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 queries: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DiscoveryQuery]
- viam.gen.robot.v1.robot_pb2.global___DiscoverComponentsRequest
- class viam.gen.robot.v1.robot_pb2.DiscoverComponentsResponse(*, discovery: collections.abc.Iterable[global___Discovery] | 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 discovery: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Discovery]
- viam.gen.robot.v1.robot_pb2.global___DiscoverComponentsResponse
- class viam.gen.robot.v1.robot_pb2.Status(*, name: viam.gen.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.
- property name: viam.gen.common.v1.common_pb2.ResourceName
- property status: google.protobuf.struct_pb2.Struct
- property last_reconfigured: google.protobuf.timestamp_pb2.Timestamp
- HasField(field_name: Literal['last_reconfigured', b'last_reconfigured', 'name', b'name', 'status', b'status']) 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.robot.v1.robot_pb2.global___Status
- class viam.gen.robot.v1.robot_pb2.GetStatusRequest(*, resource_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 resource_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]
- viam.gen.robot.v1.robot_pb2.global___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.
- property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Status]
- viam.gen.robot.v1.robot_pb2.global___GetStatusResponse
- class viam.gen.robot.v1.robot_pb2.StreamStatusRequest(*, resource_names: collections.abc.Iterable[viam.gen.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.
- property resource_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]
- property every: google.protobuf.duration_pb2.Duration
how often to send a new status.
- HasField(field_name: Literal['every', b'every']) 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.robot.v1.robot_pb2.global___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.
- property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Status]
- viam.gen.robot.v1.robot_pb2.global___StreamStatusResponse
- class viam.gen.robot.v1.robot_pb2.StopExtraParameters(*, name: viam.gen.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.
- property name: viam.gen.common.v1.common_pb2.ResourceName
- property params: google.protobuf.struct_pb2.Struct
- HasField(field_name: Literal['name', b'name', 'params', b'params']) 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.robot.v1.robot_pb2.global___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.
- property extra: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___StopExtraParameters]
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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
- property heartbeat_window: google.protobuf.duration_pb2.Duration
- HasField(field_name: Literal['heartbeat_window', b'heartbeat_window']) 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.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___SendSessionHeartbeatResponse
- class viam.gen.robot.v1.robot_pb2.LogRequest(*, logs: collections.abc.Iterable[viam.gen.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.
- property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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
use machine_part_id field.
- Type:
Deprecated
- primary_org_id: str
- location_id: str
- machine_id: str
- machine_part_id: str
- viam.gen.robot.v1.robot_pb2.global___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: Literal['id_or_name', b'id_or_name', 'module_id', b'module_id', 'module_name', b'module_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.
- WhichOneof(oneof_group: Literal['id_or_name', b'id_or_name']) Literal['module_id', 'module_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
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___GetMachineStatusRequest
- class viam.gen.robot.v1.robot_pb2.GetMachineStatusResponse(*, resources: collections.abc.Iterable[global___ResourceStatus] | None = ..., config: global___ConfigStatus | 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 resources: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceStatus]
- property config: global___ConfigStatus
- 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.robot.v1.robot_pb2.global___GetMachineStatusResponse
- class viam.gen.robot.v1.robot_pb2.ResourceStatus(*, name: viam.gen.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.
- property name: viam.gen.common.v1.common_pb2.ResourceName
resource name.
- property last_updated: google.protobuf.timestamp_pb2.Timestamp
state transition timestamp.
- property cloud_metadata: global___GetCloudMetadataResponse
infomation about resource orgID, locationID and partID
- HasField(field_name: Literal['_cloud_metadata', b'_cloud_metadata', 'cloud_metadata', b'cloud_metadata', 'last_updated', b'last_updated', '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.
- WhichOneof(oneof_group: Literal['_cloud_metadata', b'_cloud_metadata']) Literal['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
- viam.gen.robot.v1.robot_pb2.global___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.
- property last_updated: google.protobuf.timestamp_pb2.Timestamp
config ingestion timestamp.
- HasField(field_name: Literal['last_updated', b'last_updated']) 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.robot.v1.robot_pb2.global___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.
- viam.gen.robot.v1.robot_pb2.global___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
- viam.gen.robot.v1.robot_pb2.global___GetVersionResponse