viam.gen.app.cloudslam.v1.cloud_slam_pb2

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

Classes

`EndStatus`
`StartMappingSessionRequest`	StartMappingSession
`Module`	Abstract base class for protocol messages.
`SensorInfo`	Abstract base class for protocol messages.
`CaptureInterval`	Abstract base class for protocol messages.
`StartMappingSessionResponse`	Abstract base class for protocol messages.
`GetActiveMappingSessionsForRobotRequest`	GetActiveMappingSessionsForRobot
`GetActiveMappingSessionsForRobotResponse`	Abstract base class for protocol messages.
`GetMappingSessionPointCloudRequest`	GetMappingSessionPointCloud
`GetMappingSessionPointCloudResponse`	Abstract base class for protocol messages.
`ListMappingSessionsRequest`	ListMappingSessions
`ListMappingSessionsResponse`	Abstract base class for protocol messages.
`StopMappingSessionRequest`	StopMappingSession
`StopMappingSessionResponse`	Abstract base class for protocol messages.
`GetMappingSessionMetadataByIDRequest`	GetMappingSessionMetadataByID
`GetMappingSessionMetadataByIDResponse`	Abstract base class for protocol messages.
`MappingMetadata`	Abstract base class for protocol messages.

Module Contents

viam.gen.app.cloudslam.v1.cloud_slam_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.EndStatus: Bases: _EndStatus

viam.gen.app.cloudslam.v1.cloud_slam_pb2.END_STATUS_UNSPECIFIED: EndStatus

viam.gen.app.cloudslam.v1.cloud_slam_pb2.END_STATUS_SUCCESS: EndStatus

viam.gen.app.cloudslam.v1.cloud_slam_pb2.END_STATUS_TIMEOUT: EndStatus

viam.gen.app.cloudslam.v1.cloud_slam_pb2.END_STATUS_FAIL: EndStatus

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___EndStatus = EndStatus

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionRequest(*, slam_version: str = ..., viam_server_version: str = ..., map_name: str = ..., organization_id: str = ..., location_id: str = ..., robot_id: str = ..., capture_interval: Global___CaptureInterval | None = ..., sensors: collections.abc.Iterable[Global___SensorInfo] | None = ..., slam_config: google.protobuf.struct_pb2.Struct | None = ..., existing_map_version: str = ..., module: Global___Module | None = ...)

Bases: google.protobuf.message.Message

StartMappingSession

slam_version: str: Version to use for slam, defaults stable

viam_server_version: str: Version to use for viam, defaults stable

map_name: str

organization_id: str

location_id: str

robot_id: str

existing_map_version: str

capture_interval() → Global___CaptureInterval

sensors() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___SensorInfo]

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

module() → Global___Module

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.app.cloudslam.v1.cloud_slam_pb2.Global___StartMappingSessionRequest = StartMappingSessionRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.Module(*, name: str = ..., module_id: str = ..., 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.

name: str

module_id: str

version: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___Module = Module

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.SensorInfo(*, source_component_name: str = ..., type: str = ..., data_frequency_hz: 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.

source_component_name: str

type: str: type is the RDK component type

data_frequency_hz: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___SensorInfo = SensorInfo

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.CaptureInterval(*, start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_time: 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.

start_time() → google.protobuf.timestamp_pb2.Timestamp

end_time() → google.protobuf.timestamp_pb2.Timestamp: if no end_time specified cloud slam will be run using live sensors

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.app.cloudslam.v1.cloud_slam_pb2.Global___CaptureInterval = CaptureInterval

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.StartMappingSessionResponse(*, session_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.

session_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___StartMappingSessionResponse = StartMappingSessionResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotRequest(*, robot_id: str = ...)

Bases: google.protobuf.message.Message

GetActiveMappingSessionsForRobot

robot_id: str: assumes only one active mapping session on a robot

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___GetActiveMappingSessionsForRobotRequest = GetActiveMappingSessionsForRobotRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetActiveMappingSessionsForRobotResponse(*, session_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.

session_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___GetActiveMappingSessionsForRobotResponse = GetActiveMappingSessionsForRobotResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

GetMappingSessionPointCloud

session_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___GetMappingSessionPointCloudRequest = GetMappingSessionPointCloudRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionPointCloudResponse(*, map_url: str = ..., pose: common.v1.common_pb2.Pose | 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.

map_url: str: url to the pointcloud map

pose() → common.v1.common_pb2.Pose: Current position within the SLAM Map

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.app.cloudslam.v1.cloud_slam_pb2.Global___GetMappingSessionPointCloudResponse = GetMappingSessionPointCloudResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsRequest(*, organization_id: str = ..., location_id: str = ...)

Bases: google.protobuf.message.Message

ListMappingSessions

organization_id: str

location_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___ListMappingSessionsRequest = ListMappingSessionsRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.ListMappingSessionsResponse(*, session: collections.abc.Iterable[Global___MappingMetadata] | 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.

session() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___MappingMetadata]

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___ListMappingSessionsResponse = ListMappingSessionsResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

StopMappingSession

session_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___StopMappingSessionRequest = StopMappingSessionRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.StopMappingSessionResponse(*, package_id: str = ..., 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.

package_id: str

version: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___StopMappingSessionResponse = StopMappingSessionResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDRequest(*, session_id: str = ...)

Bases: google.protobuf.message.Message

GetMappingSessionMetadataByID

session_id: str

type viam.gen.app.cloudslam.v1.cloud_slam_pb2.Global___GetMappingSessionMetadataByIDRequest = GetMappingSessionMetadataByIDRequest

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.GetMappingSessionMetadataByIDResponse(*, session_metadata: Global___MappingMetadata | 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.

session_metadata() → Global___MappingMetadata

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.app.cloudslam.v1.cloud_slam_pb2.Global___GetMappingSessionMetadataByIDResponse = GetMappingSessionMetadataByIDResponse

class viam.gen.app.cloudslam.v1.cloud_slam_pb2.MappingMetadata(*, org_id: str = ..., location_id: str = ..., robot_id: str = ..., time_start_submitted: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_cloud_run_job_started: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_end_submitted: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_cloud_run_job_ended: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_status: Global___EndStatus = ..., cloud_run_job_id: str = ..., viam_server_version: str = ..., map_name: str = ..., slam_version: str = ..., config: str = ..., error_msg: 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.

org_id: str: org associated with the slam session

location_id: str: location associated with the slam session

robot_id: str: robot associated with slam session

end_status: Global___EndStatus: enums that represent “success”, “failed”, etc

cloud_run_job_id: str: initially unset

viam_server_version: str: version tag from request, defaults to stable

map_name: str: name of the map package

slam_version: str: version tag from request, defaults to stable

config: str: a robot config for a slam session

error_msg: str: additional details on the end status if needed, such as errors

time_start_submitted() → google.protobuf.timestamp_pb2.Timestamp: time this document was created

time_cloud_run_job_started() → google.protobuf.timestamp_pb2.Timestamp: time the cloud run job started

time_end_submitted() → google.protobuf.timestamp_pb2.Timestamp: time StopSlamSession was called

time_cloud_run_job_ended() → google.protobuf.timestamp_pb2.Timestamp: time the cloud run job ended

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.app.cloudslam.v1.cloud_slam_pb2.Global___MappingMetadata = MappingMetadata

`DESCRIPTOR`
`END_STATUS_UNSPECIFIED`
`END_STATUS_SUCCESS`
`END_STATUS_TIMEOUT`
`END_STATUS_FAIL`
`Global___EndStatus`
`Global___StartMappingSessionRequest`
`Global___Module`
`Global___SensorInfo`
`Global___CaptureInterval`
`Global___StartMappingSessionResponse`
`Global___GetActiveMappingSessionsForRobotRequest`
`Global___GetActiveMappingSessionsForRobotResponse`
`Global___GetMappingSessionPointCloudRequest`
`Global___GetMappingSessionPointCloudResponse`
`Global___ListMappingSessionsRequest`
`Global___ListMappingSessionsResponse`
`Global___StopMappingSessionRequest`
`Global___StopMappingSessionResponse`
`Global___GetMappingSessionMetadataByIDRequest`
`Global___GetMappingSessionMetadataByIDResponse`
`Global___MappingMetadata`

viam.gen.app.cloudslam.v1.cloud_slam_pb2

Attributes

Classes

Module Contents